Isorropia: Partitioning, Load Balancing and more
Isorropia_CostDescriber.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 //************************************************************************
00003 //
00004 //              Isorropia: Partitioning and Load Balancing Package
00005 //                Copyright (2006) Sandia Corporation
00006 //
00007 //Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 //license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 //************************************************************************
00038 //@HEADER
00039 
00040 #ifndef _Isorropia_CostDescriber_hpp_
00041 #define _Isorropia_CostDescriber_hpp_
00042 
00043 #include <Isorropia_ConfigDefs.hpp>
00044 #include <Teuchos_ParameterList.hpp>
00045 
00051 namespace Isorropia {
00052 
00061 class CostDescriber {
00062 public:
00063 
00065   virtual ~CostDescriber() {}
00066 
00067 private:
00073   virtual void setParameters(const Teuchos::ParameterList& paramlist) = 0;
00074 
00080   virtual bool haveVertexWeights() const = 0;
00081 
00088   virtual int getNumVertices() const = 0;
00089 
00099   virtual void getVertexWeights(int numVertices,
00100                                 int* global_ids,
00101                                 float* weights) const = 0;
00102 
00108   virtual bool haveGraphEdgeWeights() const = 0;
00109 
00118   virtual int getNumGraphEdges(int vertex_global_id) const = 0;
00119 
00135   virtual void getGraphEdgeWeights(int vertex_global_id,
00136                                    int num_neighbors,
00137                                    int* neighbor_global_ids,
00138                                    float* weights) const = 0;
00139 
00145   virtual bool haveHypergraphEdgeWeights() const = 0;
00146 
00152   virtual int getNumHypergraphEdgeWeights() const = 0;
00153 
00166   virtual void getHypergraphEdgeWeights(int numEdges,
00167                                         int* global_ids,
00168                                         float* weights) const = 0;
00169 };//class CostDescriber
00170 
00171 }//namespace Isorropia
00172 
00173 #endif
00174