Zoltan 2 Version 0.5
Zoltan2_OrderingSolution.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_ORDERINGSOLUTION_HPP_
00051 #define _ZOLTAN2_ORDERINGSOLUTION_HPP_
00052 
00053 #include <Zoltan2_Standards.hpp>
00054 #include <Zoltan2_Solution.hpp>
00055 
00056 namespace Zoltan2 {
00057 
00067 template <typename gid_t, typename lno_t>
00068   class OrderingSolution : public Solution
00069 {
00070 public:
00071 
00074   OrderingSolution(
00075     size_t perm_size, // TODO: Is this always equal to nlids ?
00076     size_t ngids
00077   )
00078   {
00079     HELLO;
00080     perm_size_ = perm_size;
00081     gids_   = ArrayRCP<gid_t>(ngids);
00082     perm_  = ArrayRCP<lno_t>(perm_size_);
00083   }
00084 
00085 
00087   // Accessor functions, allowing algorithms to get ptrs to solution memory.
00088   // Algorithms can then load the memory.
00089   // Non-RCP versions are provided for applications to use.
00090 
00093   inline size_t getPermutationSize() {return perm_size_;}
00094 
00097   inline ArrayRCP<gid_t>  &getGidsRCP()  {return gids_;}
00098 
00101   inline ArrayRCP<lno_t> &getPermutationRCP() {return perm_;}
00102 
00105   inline ArrayRCP<gid_t>  &getGidsRCPConst()  const
00106   {
00107     return const_cast<ArrayRCP<gid_t>& > (gids_);
00108   }
00109 
00112   inline ArrayRCP<lno_t> &getPermutationRCPConst() const
00113   {
00114     return const_cast<ArrayRCP<lno_t>& > (perm_);
00115   }
00116 
00119   inline gid_t  *getGids(size_t *length)
00120   {
00121     *length = gids_.size();
00122     return gids_.getRawPtr();
00123   }
00124 
00127   inline lno_t *getPermutation(size_t *length)
00128   {
00129     *length = perm_.size();
00130     return perm_.getRawPtr();
00131   }
00132 
00133 protected:
00134   // Ordering solution consists of GIDs, LIDs, and permutation vector(s).
00135   size_t perm_size_;
00136   ArrayRCP<gid_t>  gids_;
00137   ArrayRCP<lno_t> perm_;    // zero-based local permutation
00138   //ArrayRCP<size_t> invperm_; // inverse of permutation above
00139 };
00140 
00141 }
00142 
00143 #endif