EpetraExt_Permutation.h

Go to the documentation of this file.

//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER

#ifndef EpetraExt_PERMUTATION_H
#define EpetraExt_PERMUTATION_H

#if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The EpetraExt package is deprecated"
#endif
#endif

#include <Epetra_ConfigDefs.h>
#include <Epetra_GIDTypeVector.h>

#include <EpetraExt_Transform.h>

namespace EpetraExt {

template<typename T, typename int_type>
class TPermutation : public Epetra_GIDTypeVector<int_type>::impl,
                    public EpetraExt::StructuralSameTypeTransform<T> {
 public:
  TPermutation(Epetra_DataAccess CV,
        const Epetra_BlockMap& map,
        int_type* permutation);

  TPermutation(const Epetra_BlockMap& map);

  TPermutation(const TPermutation<T, int_type>& src);

  virtual ~TPermutation();

  typedef typename EpetraExt::SameTypeTransform<T>::TransformTypeRef OutputRef;
  typedef typename EpetraExt::SameTypeTransform<T>::TransformTypeRef InputRef;
  typedef typename EpetraExt::SameTypeTransform<T>::TransformTypePtr OutputPtr;
  typedef typename EpetraExt::SameTypeTransform<T>::TransformTypePtr InputPtr;

  OutputRef operator()( InputRef orig );

  OutputRef operator()( InputRef orig,
          bool column_permutation );

 private:
  TPermutation<T, int_type>& operator=(const TPermutation<T, int_type>& src)
    {
      //not currently supported
      abort();
      return(*this);
    }

  bool isTypeSupported();

  OutputPtr newObj_;
  InputPtr origObj_;
};

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
template<typename T>
class Permutation : public TPermutation<T, int> {
public:
  Permutation(Epetra_DataAccess CV,
        const Epetra_BlockMap& map,
        int* permutation)
      : TPermutation<T, int>(CV, map, permutation)
  {
  }

  Permutation(const Epetra_BlockMap& map)
    : TPermutation<T, int>(map)
  {
  }

  Permutation(const Permutation<T>& src)
    : TPermutation<T, int>(src)
  {
  }
};
#endif

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES

template<typename T>
class Permutation64 : public TPermutation<T, long long> {
public:
  Permutation64(Epetra_DataAccess CV,
        const Epetra_BlockMap& map,
        long long* permutation)
      : TPermutation<T, long long>(CV, map, permutation)
  {
  }

  Permutation64(const Epetra_BlockMap& map)
    : TPermutation<T, long long>(map)
  {
  }

  Permutation64(const Permutation64<T>& src)
    : TPermutation<T, long long>(src)
  {
  }
};
#endif

}//namespace EpetraExt

#include <EpetraExt_Permutation_impl.h>

#endif