AbstractLinAlgPack_GenPermMatrixSlice.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 GEN_PERM_MATRIX_SLICE_H
#define GEN_PERM_MATRIX_SLICE_H

#include "AbstractLinAlgPack_GenPermMatrixSliceIterator.hpp"

namespace AbstractLinAlgPack {

class GenPermMatrixSlice {
public:


  enum EIdentityOrZero { IDENTITY_MATRIX, ZERO_MATRIX };

  typedef GenPermMatrixSliceIteratorPack::EOrderedBy    EOrderedBy;

  typedef GenPermMatrixSliceIteratorPack::row_col_iterator<const index_type>
                      const_iterator;
  typedef ptrdiff_t           difference_type;


  GenPermMatrixSlice();

  GenPermMatrixSlice( index_type rows, index_type cols, EIdentityOrZero type );

  void initialize( index_type rows, index_type cols, EIdentityOrZero type );

  void initialize(
    index_type      rows
    ,index_type     cols
    ,index_type     nz
    ,difference_type  row_off
    ,difference_type  col_off
    ,EOrderedBy     ordered_by
    ,const index_type row_i[]
    ,const index_type col_j[]
    ,bool       test_setup = false
    );

  void initialize_and_sort(
    index_type      rows
    ,index_type     cols
    ,index_type     nz
    ,difference_type  row_off
    ,difference_type  col_off
    ,EOrderedBy     ordered_by
    ,index_type     row_i[]
    ,index_type     col_j[]
    ,bool       test_setup = false
    );
    
  void bind( const GenPermMatrixSlice& gpms );

  index_type rows() const;
  index_type cols() const;
  index_type nz() const;
  EOrderedBy ordered_by() const;
  bool is_identity() const;

  index_type lookup_row_i(index_type col_j) const;

  index_type lookup_col_j(index_type row_i) const;


  const_iterator begin() const;

  const_iterator end() const;


  const GenPermMatrixSlice create_submatrix( const Range1D& rng
    , EOrderedBy ordered_by ) const;

private:

  // //////////////////////////////
  // Private data members

  index_type      rows_;
  index_type      cols_;
  index_type      nz_;
  difference_type   row_off_;
  difference_type   col_off_;
  EOrderedBy      ordered_by_;
  const index_type    *row_i_;
  const index_type    *col_j_;

  // //////////////////////////////
  // Private static data members

  // ToDo: We could allocate a class-wide array, initialize
  // it to [1,2,3 ...] and then use it for the iterators
  // when is_idenity() == true!  This would make implementing
  // a lot of code a lot easier if we don't care about a little
  // inefficiency!  We could just allocate a large chunk
  // of memory by default (or client could do this for us)
  // and then construct it when needed.  If a client ever
  // requested an iterator when not enough storage was avalible
  // then we would throw an exception.

  // //////////////////////////////
  // Private member functions

  // Validate the input data (not the ordering!)
  static void validate_input_data(
    index_type      rows
    ,index_type     cols
    ,index_type     nz
    ,difference_type  row_off
    ,difference_type  col_off
    ,EOrderedBy     ordered_by
    ,const index_type row_i[]
    ,const index_type col_j[]
    ,std::ostringstream &omsg
    );

  void validate_not_identity() const;
  
  GenPermMatrixSlice& operator=( const GenPermMatrixSlice& );

};  // end class GenPermMatrixSlice

// //////////////////////////////////////////////////////////
// Inline members for GenPermMatrixSlice

inline
GenPermMatrixSlice::GenPermMatrixSlice( index_type rows, index_type cols, EIdentityOrZero type )
{
  initialize(rows,cols,type);
}

inline
index_type GenPermMatrixSlice::rows() const
{
  return rows_;
}

inline
index_type GenPermMatrixSlice::cols() const
{
  return cols_;
}

inline
index_type GenPermMatrixSlice::nz() const
{
  return nz_;
}

inline
bool GenPermMatrixSlice::is_identity() const
{
  return nz_ > 0 && row_i_ == NULL;
}

inline
GenPermMatrixSlice::EOrderedBy GenPermMatrixSlice::ordered_by() const
{
  return ordered_by_;
}

} // end namespace AbstractLinAlgPack

#endif   // GEN_PERM_MATRIX_SLICE_H