Zoltan 2 Version 0.5
Zoltan2_BasicIdentifierInput.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_BASICIDENTIFIERINPUT_HPP_
00051 #define _ZOLTAN2_BASICIDENTIFIERINPUT_HPP_
00052 
00053 #include <Zoltan2_IdentifierInput.hpp>
00054 #include <Zoltan2_StridedData.hpp>
00055 
00056 namespace Zoltan2 {
00057 
00082 template <typename User>
00083   class BasicIdentifierInput: public IdentifierInput<User> {
00084 
00085 public:
00086 
00087   typedef typename InputTraits<User>::scalar_t    scalar_t;
00088   typedef typename InputTraits<User>::lno_t    lno_t;
00089   typedef typename InputTraits<User>::gno_t    gno_t;
00090   typedef typename InputTraits<User>::gid_t    gid_t;
00091   typedef typename InputTraits<User>::node_t   node_t;
00092   typedef IdentifierInput<User>       base_adapter_t;
00093   typedef User user_t;
00094 
00110   BasicIdentifierInput( lno_t numIds, const gid_t *idPtr, 
00111     vector<const scalar_t *> &weights, vector<int> &weightStrides);
00112 
00114   // The InputAdapter interface.
00116 
00117   string inputAdapterName() const {return string("BasicIdentifier");}
00118 
00119   size_t getLocalNumberOfObjects() const { return numIds_;}
00120 
00121   int getNumberOfWeightsPerObject() const { return weights_.size();}
00122 
00123   size_t getObjectWeights(int dim, const scalar_t *&wgt, int &stride) const
00124   {
00125     return getIdentifierWeights(dim, wgt, stride);
00126   }
00127 
00129   // The IdentifierInput interface.
00130   // This is the interface that would be called by a model or a problem .
00132 
00133   size_t getLocalNumberOfIdentifiers() const { return numIds_;}
00134    
00135   int getNumberOfWeights() const { return weights_.size(); }
00136 
00137   size_t getIdentifierList(const gid_t *&Ids) const
00138   {
00139     Ids = idList_;
00140     return numIds_;
00141   }
00142 
00143   size_t getIdentifierWeights(int dimension,
00144      const scalar_t *&weights, int &stride) const
00145   {
00146     env_->localInputAssertion(__FILE__, __LINE__, "invalid weight dimension",
00147       dimension >= 0 && dimension < weights_.size(), BASIC_ASSERTION);
00148 
00149     size_t length;
00150     weights_[dimension].getStridedList(length, weights, stride);
00151     return length;
00152   }
00153 
00154 private:
00155 
00156   RCP<const Environment> env_;
00157   lno_t numIds_;
00158   const gid_t *idList_;
00159   ArrayRCP<StridedData<lno_t, scalar_t> > weights_;
00160 };
00161 
00163 // Definitions
00165 
00166 template <typename User>
00167   BasicIdentifierInput<User>::BasicIdentifierInput(
00168     lno_t numIds, const gid_t *idPtr,
00169     vector<const scalar_t *> &weights, vector<int> &weightStrides):
00170       numIds_(numIds), idList_(idPtr), weights_()
00171 {
00172   typedef StridedData<lno_t,scalar_t> input_t;
00173   env_ = rcp(new Environment);    // for error messages
00174   size_t numWeights = weights.size();
00175 
00176   if (numWeights > 0){
00177     weights_ = arcp(new input_t [numWeights], 0, numWeights, true);
00178 
00179     if (numIds > 0){
00180       for (size_t i=0; i < numWeights; i++){
00181         int stride = weightStrides.size() ? weightStrides[i] : 1;
00182         ArrayRCP<const scalar_t> wgtV(weights[i], 0, stride*numIds, false);
00183         weights_[i] = input_t(wgtV, stride);
00184       }
00185     }
00186   }
00187 }
00188 
00189   
00190   
00191 }  //namespace Zoltan2
00192   
00193 #endif