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

Isorropia_CostDescriber.hpp

00001 //@HEADER
00002 /*
00003 ************************************************************************
00004 
00005               Isorropia: Partitioning and Load Balancing Package
00006                 Copyright (2006) Sandia Corporation
00007 
00008 Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 license for use of this work by or on behalf of the U.S. Government.
00010 
00011 This library is free software; you can redistribute it and/or modify
00012 it under the terms of the GNU Lesser General Public License as
00013 published by the Free Software Foundation; either version 2.1 of the
00014 License, or (at your option) any later version.
00015 
00016 This library is distributed in the hope that it will be useful, but
00017 WITHOUT ANY WARRANTY; without even the implied warranty of
00018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 Lesser General Public License for more details.
00020 
00021 You should have received a copy of the GNU Lesser General Public
00022 License along with this library; if not, write to the Free Software
00023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 USA
00025 Questions? Contact Alan Williams (william@sandia.gov)
00026                 or Erik Boman    (egboman@sandia.gov)
00027 
00028 ************************************************************************
00029 */
00030 //@HEADER
00031 
00032 #ifndef _Isorropia_CostDescriber_hpp_
00033 #define _Isorropia_CostDescriber_hpp_
00034 
00035 #include <Isorropia_configdefs.hpp>
00036 #include <Teuchos_ParameterList.hpp>
00037 
00041 namespace Isorropia {
00042 
00059 class CostDescriber {
00060 public:
00061 
00063   virtual ~CostDescriber() {}
00064 
00070   virtual void setParameters(const Teuchos::ParameterList& paramlist) = 0;
00071 
00076   virtual bool haveVertexWeights() const = 0;
00077 
00081   virtual int getNumVertices() const = 0;
00082 
00085   virtual void getVertexWeights(int numVertices,
00086                                 int* global_ids,
00087                                 float* weights) const = 0;
00088 
00093   virtual bool haveGraphEdgeWeights() const = 0;
00094 
00098   virtual int getNumGraphEdges(int vertex_global_id) const = 0;
00099 
00102   virtual void getGraphEdgeWeights(int vertex_global_id,
00103                                    int num_neighbors,
00104                                    int* neighbor_global_ids,
00105                                    float* weights) const = 0;
00106 
00111   virtual bool haveHypergraphEdgeWeights() const = 0;
00112 
00116   virtual int getNumHypergraphEdges() const = 0;
00117 
00120   virtual void getHypergraphEdgeWeights(int numEdges,
00121                                         int* global_ids,
00122                                         float* weights) const = 0;
00123 };//class CostDescriber
00124 
00125 }//namespace Isorropia
00126 
00127 #endif
00128