Isorropia_EpetraCostDescriber.hpp

Go to the documentation of this file.

//@HEADER
//************************************************************************
//
//              Isorropia: Partitioning and Load Balancing Package
//                Copyright (2006) Sandia Corporation
//
//Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
//license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//************************************************************************
//@HEADER

#ifndef _Isorropia_EpetraCostDescriber_hpp_
#define _Isorropia_EpetraCostDescriber_hpp_

#include <Isorropia_ConfigDefs.hpp>
#include <Isorropia_CostDescriber.hpp>
#include <Teuchos_RCP.hpp>
#include <Teuchos_ParameterList.hpp>

#include <map>
#include <list>
#include <set>
#include <iostream>

#ifdef HAVE_EPETRA
class Epetra_Vector;
class Epetra_CrsMatrix;
class Epetra_RowMatrix;
class Epetra_MultiVector;
class Epetra_Import;
class Epetra_CrsGraph;

namespace Isorropia {

class Operator;

namespace Epetra {

// Forward declarations of friends

namespace ZoltanLib{
  class QueryObject;
}
class ZoltanLibClass;

class CostDescriber : public Isorropia::CostDescriber {

  // public methods are part of API, private methods are used by different
  // classes in isorropia

  friend class Isorropia::Operator;
  friend class Isorropia::Epetra::ZoltanLib::QueryObject;
  friend class Isorropia::Epetra::ZoltanLibClass;

public:
  CostDescriber();

  ~CostDescriber();

  CostDescriber(const CostDescriber &costs);

  friend std::ostream& operator <<(std::ostream &, const Isorropia::Epetra::CostDescriber &cd);

  void setVertexWeights(Teuchos::RCP<const Epetra_Vector> vwgts);

  void setGraphEdgeWeights(Teuchos::RCP<const Epetra_CrsMatrix> gewts);

  void setHypergraphEdgeWeights(Teuchos::RCP<const Epetra_Vector> hgewts);

  void setHypergraphEdgeWeights(int numHGedges, const int *hgGIDs, const float *hgEwgts);

  void setHypergraphEdgeWeights(int numHGedges, const int *hgGIDs, const double *hgEwgts);

  void getCosts(std::map<int, float > &vertexWeights,
                std::map<int, std::map<int, float > > &graphEdgeWeights,
                std::map<int, float > &hypergraphEdgeWeights) const;

  void show_cd(std::ostream &) const;

  // Add documentation

#ifdef USE_UTILS
  int compareBeforeAndAfterHypergraph( const Epetra_RowMatrix &in_m, const Epetra_RowMatrix &out_m,
            const Epetra_Import &importer,
            std::vector<double> &balance, std::vector<double> &cutn, std::vector<double> &cutl) const;

  int compareBeforeAndAfterGraph( const Epetra_RowMatrix &in_m, const Epetra_RowMatrix &out_m,
            const Epetra_Import &importer,
            std::vector<double> &balance, std::vector<int> &numCuts, std::vector<double> &cutWgt,
            std::vector<double> &cutn, std::vector<double> &cutl) const;

  int compareBeforeAndAfterGraph( const Epetra_CrsGraph &in_g, const Epetra_CrsGraph &out_g,
            const Epetra_Import &importer,
            std::vector<double> &balance, std::vector<int> &numCuts, std::vector<double> &cutWgt,
            std::vector<double> &cutn, std::vector<double> &cutl) const;

  int compareBeforeAndAfterImbalance(const Epetra_MultiVector &mv, const  Epetra_Import &importer,
                  std::vector<double> &min, std::vector<double> &max, std::vector<double> &avg) const;
#endif

private:

  void _transformWeights(const Epetra_Import &importer);

  int _compareBeforeAndAfterGraph( const Epetra_RowMatrix *in_m, const Epetra_RowMatrix *out_m,
            const Epetra_CrsGraph *in_g, const Epetra_CrsGraph *out_g,
            const Epetra_Import &importer,
            std::vector<double> &balance, std::vector<int> &numCuts, std::vector<double> &cutWgt,
            std::vector<double> &cutn, std::vector<double> &cutl) const;

  void setParameters(const Teuchos::ParameterList& paramlist);

  bool haveVertexWeights() const;
  int getNumVertices() const;
  void getVertexWeights(int numVertices,
                      int* global_ids, float* weights) const; 
  bool haveGraphEdgeWeights() const;
  int getNumGraphEdges(int vertex_global_id) const;

  int getGraphEdgeVertices(std::set<int> &gids) const;


  void getGraphEdgeWeights(int vertex_global_id,
                                   int num_neighbors,
                                   int* neighbor_global_ids,
                                   float* weights) const; 
  bool haveHypergraphEdgeWeights() const;
  int getNumHypergraphEdgeWeights() const;
  void getHypergraphEdgeWeights(int numEdges,
                                        int* global_ids,
                                        float* weights) const;

   int getHypergraphEdgeWeights(std::map<int, float> &wgtMap) const;


  int getVertexWeights(std::map<int, float> &wgtMap) const;

  // TODO documentation
  const Epetra_Vector &getVertexWeights() { return *vertex_weights_;}


  int getGraphEdgeWeights(int vertex_global_id, std::map<int, float> &wgtMap) const;



  bool haveGlobalVertexWeights() const;

  void setNumGlobalVertexWeights(int num);

  bool haveGlobalGraphEdgeWeights() const;

  void setNumGlobalGraphEdgeWeights(int num);

  bool haveGlobalHypergraphEdgeWeights() const;

  void setNumGlobalHypergraphEdgeWeights(int num);

  void allocate_hg_edge_weights_(int n);

  void free_hg_edge_weights_();

  Teuchos::RCP<const Epetra_Vector> vertex_weights_;
  Teuchos::RCP<const Epetra_CrsMatrix> graph_edge_weights_;
  std::set<int> graph_self_edges_;

  Teuchos::ParameterList paramlist_;

  int *hg_edge_gids_;
  float *hg_edge_weights_;
  int num_hg_edge_weights_;

  int numGlobalVertexWeights_;
  int numGlobalGraphEdgeWeights_;
  int numGlobalHypergraphEdgeWeights_;

  int getEdges(int vertexGID, int len, int *nborGID, float *weights) const;

};//class CostDescriber

}//namespace Epetra
}//namespace Isorropia

#endif //HAVE_EPETRA

#endif


#if defined(Isorropia_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Isorropia package is deprecated"
#endif
#endif