EpetraExt Package Browser (Single Doxygen Collection) Development
EpetraExt_Permutation.h
Go to the documentation of this file.
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //     EpetraExt: Epetra Extended - Linear Algebra Services Package
00005 //                 Copyright (2011) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 
00042 #ifndef EpetraExt_PERMUTATION_H
00043 #define EpetraExt_PERMUTATION_H
00044 
00045 #include <Epetra_ConfigDefs.h>
00046 #include <Epetra_GIDTypeVector.h>
00047 
00048 #include <EpetraExt_Transform.h>
00049 
00050 namespace EpetraExt {
00051 
00116 template<typename T, typename int_type>
00117 class TPermutation : public Epetra_GIDTypeVector<int_type>::impl,
00118                     public EpetraExt::StructuralSameTypeTransform<T> {
00119  public:
00131   TPermutation(Epetra_DataAccess CV,
00132         const Epetra_BlockMap& map,
00133         int_type* permutation);
00134 
00140   TPermutation(const Epetra_BlockMap& map);
00141 
00143   TPermutation(const TPermutation<T, int_type>& src);
00144 
00146   virtual ~TPermutation();
00147 
00148   typedef typename EpetraExt::SameTypeTransform<T>::TransformTypeRef OutputRef;
00149   typedef typename EpetraExt::SameTypeTransform<T>::TransformTypeRef InputRef;
00150   typedef typename EpetraExt::SameTypeTransform<T>::TransformTypePtr OutputPtr;
00151   typedef typename EpetraExt::SameTypeTransform<T>::TransformTypePtr InputPtr;
00152 
00170   OutputRef operator()( InputRef orig );
00171 
00185   OutputRef operator()( InputRef orig,
00186           bool column_permutation );
00187 
00188  private:
00189   TPermutation<T, int_type>& operator=(const TPermutation<T, int_type>& src)
00190     {
00191       //not currently supported
00192       abort();
00193       return(*this);
00194     }
00195 
00196   bool isTypeSupported();
00197 
00198   OutputPtr newObj_;
00199   InputPtr origObj_;
00200 };
00201 
00202 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00203 template<typename T>
00204 class Permutation : public TPermutation<T, int> {
00205 public:
00217   Permutation(Epetra_DataAccess CV,
00218         const Epetra_BlockMap& map,
00219         int* permutation)
00220       : TPermutation<T, int>(CV, map, permutation)
00221   {
00222   }
00223 
00229   Permutation(const Epetra_BlockMap& map)
00230     : TPermutation<T, int>(map)
00231   {
00232   }
00233 
00235   Permutation(const Permutation<T>& src)
00236     : TPermutation<T, int>(src)
00237   {
00238   }
00239 };
00240 #endif
00241 
00242 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00243 
00244 template<typename T>
00245 class Permutation64 : public TPermutation<T, long long> {
00246 public:
00258   Permutation64(Epetra_DataAccess CV,
00259         const Epetra_BlockMap& map,
00260         long long* permutation)
00261       : TPermutation<T, long long>(CV, map, permutation)
00262   {
00263   }
00264 
00270   Permutation64(const Epetra_BlockMap& map)
00271     : TPermutation<T, long long>(map)
00272   {
00273   }
00274 
00276   Permutation64(const Permutation64<T>& src)
00277     : TPermutation<T, long long>(src)
00278   {
00279   }
00280 };
00281 #endif
00282 
00283 }//namespace EpetraExt
00284 
00285 #include <EpetraExt_Permutation_impl.h>
00286 
00287 #endif
00288 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines