Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members

Isorropia::Epetra::CostDescriber Class Reference

An Epetra-specific implementation of Isorropia::CostDescriber. More...

#include <Isorropia_EpetraCostDescriber.hpp>

Inheritance diagram for Isorropia::Epetra::CostDescriber:

[legend]
Collaboration diagram for Isorropia::Epetra::CostDescriber:
[legend]
List of all members.

Public Member Functions

 CostDescriber ()
 Constructor.
virtual ~CostDescriber ()
 Destructor.
void setParameters (const Teuchos::ParameterList &paramlist)
 Set parameters for the CostDescriber instance.
void setVertexWeights (Teuchos::RefCountPtr< Epetra_Vector > vwts)
 Vertex Weights; these typically correspond to matrix rows.
void setGraphEdgeWeights (Teuchos::RefCountPtr< Epetra_CrsMatrix > gewts)
 Graph edge weights; these typically correspond to matrix nonzeros.
void setHypergraphEdgeWeights (Teuchos::RefCountPtr< Epetra_Vector > hgewts)
 Hypergraph edge weights; these typically correspond to matrix columns.
bool haveVertexWeights () const
 Query whether non-default vertex weights are present.
int getNumVertices () const
 Get the number of vertices.
void getVertexWeights (int numVertices, int *global_ids, float *weights) const
 Get the lists of vertex ids and weights.
bool haveGraphEdgeWeights () const
 Query whether non-default graph edge weights are present.
int getNumGraphEdges (int vertex_global_id) const
 Get the number of graph edges for a specified vertex.
void getGraphEdgeWeights (int vertex_global_id, int num_neighbors, int *neighbor_global_ids, float *weights) const
 Get the graph edge weights for a specified vertex.
bool haveHypergraphEdgeWeights () const
 Query whether non-default hypergraph edge weights are present.
int getNumHypergraphEdges () const
 Get the number of Hypergraph edges.
void getHypergraphEdgeWeights (int numEdges, int *global_ids, float *weights) const
 Get the hypergraph edge weights.

Detailed Description

An Epetra-specific implementation of Isorropia::CostDescriber.

Member Function Documentation

void Isorropia::Epetra::CostDescriber::setParameters (  const Teuchos::ParameterList &  paramlist  )  [virtual]
 

Set parameters for the CostDescriber instance.

The contents of the input paramlist object are copied into an internal ParameterList attribute. This class does not retain a reference to the input ParameterList after this method returns.

Implements Isorropia::CostDescriber.

bool Isorropia::Epetra::CostDescriber::haveVertexWeights (   )  const [virtual]
 

Query whether non-default vertex weights are present.

If this function returns false, the caller can assume that vertex weights are all 1.0.

Implements Isorropia::CostDescriber.

int Isorropia::Epetra::CostDescriber::getNumVertices (   )  const [virtual]
 

Get the number of vertices.

Vertices typically correspond to matrix rows.

Implements Isorropia::CostDescriber.

bool Isorropia::Epetra::CostDescriber::haveGraphEdgeWeights (   )  const [virtual]
 

Query whether non-default graph edge weights are present.

If this function returns false, the caller can assume that graph edge weights are all 1.0.

Implements Isorropia::CostDescriber.

int Isorropia::Epetra::CostDescriber::getNumGraphEdges (  int  vertex_global_id  )  const [virtual]
 

Get the number of graph edges for a specified vertex.

Graph edges typically correspond to matrix nonzeros.

Implements Isorropia::CostDescriber.

bool Isorropia::Epetra::CostDescriber::haveHypergraphEdgeWeights (   )  const [virtual]
 

Query whether non-default hypergraph edge weights are present.

If this function returns false, the caller can assume that hypergraph edge weights are all 1.0.

Implements Isorropia::CostDescriber.

int Isorropia::Epetra::CostDescriber::getNumHypergraphEdges (   )  const [virtual]
 

Get the number of Hypergraph edges.

Hypergraph edges typically correspond to matrix columns.

Implements Isorropia::CostDescriber.

The documentation for this class was generated from the following file: