MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractLinAlgPack_MatrixBase.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ABSTRACT_LINALG_PACK_MATRIX_BASE_H
43 #define ABSTRACT_LINALG_PACK_MATRIX_BASE_H
44 
45 #include <stdexcept>
46 
48 
49 namespace AbstractLinAlgPack {
50 
53 class MatrixBase {
54 public:
55 
57  class IncompatibleMatrices : public std::logic_error
58  {public: IncompatibleMatrices(const std::string& what_arg) : std::logic_error(what_arg) {}};
59 
61  virtual ~MatrixBase() {}
62 
65 
67  virtual const VectorSpace& space_cols() const = 0;
68 
70  virtual const VectorSpace& space_rows() const = 0;
71 
73 
76 
81  virtual size_type rows() const;
82 
87  virtual size_type cols() const;
88 
94  virtual size_type nz() const;
95 
97 
98 }; // end class MatrixBase
99 
100 } // end namespace AbstractLinAlgPack
101 
102 #endif // ABSTRACT_LINALG_PACK_MATRIX_BASE_H
virtual size_type nz() const
Return the number of nonzero elements in the matrix.
Base class for all polymorphic matrices.
virtual const VectorSpace & space_rows() const =0
Vector space for vectors that are compatible with the rows of the matrix.
virtual ~MatrixBase()
Virtual destructor.
virtual size_type cols() const
Return the number of columns in the matrix.
Abstract interface for objects that represent a space for mutable coordinate vectors.
virtual const VectorSpace & space_cols() const =0
Vector space for vectors that are compatible with the columns of the matrix.
virtual size_type rows() const
Return the number of rows in the matrix.