Isorropia_CostDescriber.hpp

//@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.

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
Questions? Contact Alan Williams (william@sandia.gov)
                or Erik Boman    (egboman@sandia.gov)

************************************************************************
*/
//@HEADER

#ifndef _Isorropia_CostDescriber_hpp_
#define _Isorropia_CostDescriber_hpp_

#include <Isorropia_configdefs.hpp>
#include <Teuchos_ParameterList.hpp>

namespace Isorropia {

class CostDescriber {
public:

  virtual ~CostDescriber() {}

  virtual void setParameters(const Teuchos::ParameterList& paramlist) = 0;

  virtual bool haveVertexWeights() const = 0;

  virtual int getNumVertices() const = 0;

  virtual void getVertexWeights(int numVertices,
                                int* global_ids,
                                float* weights) const = 0;

  virtual bool haveGraphEdgeWeights() const = 0;

  virtual int getNumGraphEdges(int vertex_global_id) const = 0;

  virtual void getGraphEdgeWeights(int vertex_global_id,
                                   int num_neighbors,
                                   int* neighbor_global_ids,
                                   float* weights) const = 0;

  virtual bool haveHypergraphEdgeWeights() const = 0;

  virtual int getNumHypergraphEdges() const = 0;

  virtual void getHypergraphEdgeWeights(int numEdges,
                                        int* global_ids,
                                        float* weights) const = 0;
};//class CostDescriber

}//namespace Isorropia

#endif