AbstractLinAlgPack_PermutationSerial.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef SLAP_PERMUTATION_SERIAL_H
#define SLAP_PERMUTATION_SERIAL_H

#include "AbstractLinAlgPack_VectorSpaceSerial.hpp"
#include "AbstractLinAlgPack_Permutation.hpp"

namespace AbstractLinAlgPack {

class PermutationSerial
  : public AbstractLinAlgPack::Permutation
{
public:


  typedef Teuchos::RCP<const IVector>  i_vector_ptr_t;



  PermutationSerial( size_type dim = 0 );

  PermutationSerial(
    const i_vector_ptr_t      &perm
    ,const i_vector_ptr_t     &inv_perm
    ,bool                     allocate_missing_perm = true
    ,bool                     check_inv_perm        = false
    );
  
  void initialize_identity( size_type dim );

  void initialize(
    const i_vector_ptr_t      &perm
    ,const i_vector_ptr_t     &inv_perm
    ,bool                     allocate_missing_perm = true
    ,bool                     check_inv_perm        = false
    );


  
  const i_vector_ptr_t& perm() const;
  const i_vector_ptr_t& inv_perm() const;


  
  const VectorSpace& space() const;
  size_type dim() const;
  bool is_identity() const;
  std::ostream& output(std::ostream& out) const;
  void permute( 
    BLAS_Cpp::Transp          P_trans
    ,const Vector       &x
    ,VectorMutable      *y
    ) const;
  void permute( 
    BLAS_Cpp::Transp          P_trans
    ,VectorMutable      *y
    ) const;


private:
  
#ifdef DOXYGEN_COMPILE
  VectorSpaceSerial     space;
  DenseLinAlgPack::IVector   *perm;
  DenseLinAlgPack::IVector   *inv_perm;
#else
  VectorSpaceSerial     space_;
  i_vector_ptr_t        perm_;
  i_vector_ptr_t        inv_perm_;
#endif

}; // end class PermutationSerial

// //////////////////////////////////////////////
// Inline members

inline
const PermutationSerial::i_vector_ptr_t&
PermutationSerial::perm() const
{
  return perm_;
}

inline
const PermutationSerial::i_vector_ptr_t&
PermutationSerial::inv_perm() const
{
  return inv_perm_;
}

} // end namespace AbstractLinAlgPack

#endif // SLAP_PERMUTATION_SERIAL_H