AbstractLinAlgPack_COOMatrixClass.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 COO_MATRIX_CLASS_H
#define COO_MATRIX_CLASS_H

#include <valarray>
#include <vector>

#include "AbstractLinAlgPack_Types.hpp"
#include "MiRefCount.h"

namespace AbstractLinAlgPack {

class COOMatrix {
public:
  // ///////////////////////////////////////////////////////////////
  // Friends
  
  // ///////////////////////////////////////////////////////////////
  // Public interface

  typedef AbstractLinAlgPack::size_type         size_type;
  typedef AbstractLinAlgPack::indice_type       indice_type;
  typedef AbstractLinAlgPack::value_type        value_type;


  
  COOMatrix();


  COOMatrix& operator=(const COOMatrix& coom);

  void resize(size_type rows, size_type cols, size_type nz);

  size_type rows() const;
  size_type cols() const;
  size_type nz() const;

  value_type*             val();
  const value_type*         val() const;
  const value_type*         const_val() const;
  indice_type*            ivect();
  const indice_type*          ivect() const;
  const indice_type*          const_ivect() const;
  indice_type*            jvect();
  const indice_type*          jvect() const;
  const indice_type*          const_jvect() const;

  void initialize(std::istream& istrm);

private:
  // ///////////////////////////////////////////////////////////////////////////
  // Private types

  typedef MemMngPack::RefCount<
    std::valarray<indice_type> >          va_indice_ref_type;

  typedef std::valarray<value_type>         va_value_type;

  typedef std::valarray<indice_type>          va_indice_type;

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

  size_type         rows_,  // The number of rows this sparse matrix represents
                cols_,  // The numner of columns this sparse matrix represents
                nz_;    // The number of non-zero elements this matrix holds.
  va_value_type       val_;   // The vector of non-zero elements
  va_indice_ref_type      ivect_ref_, // The vector of row indices
                jvect_ref_; // The vector of column indices

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

};  // end class COOMatrix

// ///////////////////////////////////////////////////////////////////////////////////
// Inline member function definitions for COOMatrix

// constructors
inline COOMatrix::COOMatrix() : rows_(0), cols_(0), nz_(0)
{}
// dimensions
inline COOMatrix::size_type COOMatrix::rows() const {
  return rows_;
}
inline COOMatrix::size_type COOMatrix::cols() const {
  return cols_;
}
inline COOMatrix::size_type COOMatrix::nz() const {
  return nz_;
}
// representation vectors (val, ivect, jvect)
inline COOMatrix::value_type* COOMatrix::val() {
  return &val_[0];
}
inline const COOMatrix::value_type* COOMatrix::val() const {
  return const_val();
}
inline const COOMatrix::value_type* COOMatrix::const_val() const {
  return &const_cast<va_value_type&>(val_)[0];
}
inline COOMatrix::indice_type* COOMatrix::ivect() {
  return &(ivect_ref_.obj())[0];
}
inline const COOMatrix::indice_type* COOMatrix::ivect() const {
  return const_ivect();
}
inline const COOMatrix::indice_type* COOMatrix::const_ivect() const {
  return &const_cast<va_indice_type&>(ivect_ref_.const_obj())[0];
}
inline COOMatrix::indice_type* COOMatrix::jvect() {
  return &jvect_ref_.obj()[0];
}
inline const COOMatrix::indice_type* COOMatrix::jvect() const {
  return const_jvect();
}
inline const COOMatrix::indice_type* COOMatrix::const_jvect() const {
  return &const_cast<va_indice_type&>(jvect_ref_.const_obj())[0];
}

} // end namespace AbstractLinAlgPack

#endif // COO_MATRIX_CLASS_H