Zoltan2 Version of the Day
Zoltan2_VectorInput.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //   Zoltan2: A package of combinatorial algorithms for scientific computing
00006 //                  Copyright 2012 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Karen Devine      (kddevin@sandia.gov)
00039 //                    Erik Boman        (egboman@sandia.gov)
00040 //                    Siva Rajamanickam (srajama@sandia.gov)
00041 //
00042 // ***********************************************************************
00043 //
00044 // @HEADER
00045 
00051 #ifndef _ZOLTAN2_VECTORINPUT_HPP_
00052 #define _ZOLTAN2_VECTORINPUT_HPP_
00053 
00054 #include <Zoltan2_InputAdapter.hpp>
00055 #include <Zoltan2_PartitioningSolution.hpp>
00056 
00057 namespace Zoltan2 {
00058 
00102 template <typename User>
00103   class VectorInput : public InputAdapter<User> {
00104 private:
00105 
00106 public:
00107 
00108 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00109   typedef typename InputTraits<User>::scalar_t    scalar_t;
00110   typedef typename InputTraits<User>::lno_t    lno_t;
00111   typedef typename InputTraits<User>::gno_t    gno_t;
00112   typedef typename InputTraits<User>::gid_t    gid_t;
00113   typedef typename InputTraits<User>::node_t   node_t;
00114   typedef User user_t;
00115 #endif
00116 
00119   virtual ~VectorInput() {};
00120 
00122   // The InputAdapter interface.
00124 
00125   enum InputAdapterType inputAdapterType() const {return VectorAdapterType;}
00126 
00128   // My interface.
00130 
00133   virtual int getNumberOfVectors() const = 0;
00134 
00139   virtual int getNumberOfWeights() const = 0;
00140 
00143   virtual size_t getLocalLength() const = 0;
00144 
00156   virtual size_t getVector(const gid_t *&ids, 
00157      const scalar_t *&elements, int &stride) const = 0;
00158 
00171   virtual size_t getVector(int i, const gid_t *&ids, 
00172      const scalar_t *&elements, int &stride) const = 0;
00173 
00187   virtual size_t getVectorWeights(int dimension,
00188      const scalar_t *&weights, int &stride) const = 0;
00189 
00208   template <typename Adapter>
00209     size_t applyPartitioningSolution(User &in, User *&out,
00210          const PartitioningSolution<Adapter> &solution) const
00211   {
00212     return 0;
00213   } 
00214 };
00215   
00216   
00217 }  //namespace Zoltan2
00218   
00219 #endif