Zoltan2 Version of the Day
Zoltan2_MatrixInput.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 
00050 #ifndef _ZOLTAN2_MATRIXINPUT_HPP_
00051 #define _ZOLTAN2_MATRIXINPUT_HPP_
00052 
00053 #include <Zoltan2_InputAdapter.hpp>
00054 #include <Zoltan2_PartitioningSolution.hpp>
00055 
00056 namespace Zoltan2 {
00057 
00103 template <typename User>
00104   class MatrixInput : public InputAdapter<User> {
00105 private:
00106 
00107 public:
00108 
00109 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00110   typedef typename InputTraits<User>::scalar_t    scalar_t;
00111   typedef typename InputTraits<User>::lno_t    lno_t;
00112   typedef typename InputTraits<User>::gno_t    gno_t;
00113   typedef typename InputTraits<User>::gid_t    gid_t;
00114   typedef typename InputTraits<User>::node_t   node_t;
00115   typedef User user_t;
00116 #endif
00117 
00118   enum InputAdapterType inputAdapterType() const {return MatrixAdapterType;}
00119 
00122   virtual ~MatrixInput(){};
00123 
00126   virtual size_t getLocalNumRows() const = 0;
00127 
00130   virtual size_t getLocalNumColumns() const = 0;
00131 
00144   virtual size_t getRowListView(const gid_t *&rowIds, 
00145     const lno_t *&offsets, const gid_t *& colIds) const = 0;
00146 
00153   virtual int getRowWeightDimension() const = 0;
00154 
00172   virtual size_t getRowWeights(int weightDim,
00173      const scalar_t *&weights, int &stride) const = 0;
00174 
00186   virtual bool getRowWeightIsNumberOfNonZeros(int dim) const = 0;
00187 
00196   virtual int getCoordinateDimension() const = 0;
00197 
00219   virtual size_t getRowCoordinates(int coordDim,
00220     const scalar_t *&coords, int &stride) const = 0;
00221 
00238   template <typename Adapter>
00239     size_t applyPartitioningSolution(const User &in, User *&out,
00240          const PartitioningSolution<Adapter> &solution) const
00241   {
00242     return 0;
00243   }
00244 
00245 };
00246   
00247 }  //namespace Zoltan2
00248   
00249 #endif