AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_SparseElement.hpp
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 SPARSE_ELEMENT_H
43 #define SPARSE_ELEMENT_H
44 
45 #include "AbstractLinAlgPack_Types.hpp"
46 
47 namespace AbstractLinAlgPack {
48 
59 template <class T_Index, class T_Value>
61 public:
64 
66  typedef T_Value value_type;
68  typedef T_Index index_type;
69 
71 
74 
77  {
78  idx_pad_.index_ = 0;
79  value_ = 0.0;
80  }
81 
84  {
85  idx_pad_.index_ = index;
86  value_ = value;
87  }
88 
90 
93 
96  {
97  return value_;
98  }
100  const value_type& value() const
101  {
102  return value_;
103  }
105  const index_type& index() const
106  {
107  return idx_pad_.index_;
108  }
111  idx_pad_.index_ = index;
112  value_ = value;
113  }
116  {
117  idx_pad_.index_ = index;
118  }
119 
121 
122 private:
123  union index_and_padding {
124  value_type dummy; // This is just included for alignment
125  index_type index_; // so that sizeof(this) == 2*sizeof(value_type)
126  };
127  index_and_padding idx_pad_;
128  value_type value_;
129 
130 }; // end class SparseElement
131 
132 } // end namespace AbstractLinAlgPack
133 
134 #endif // SPARSE_ELEMENT_H
void change_index(index_type index)
Change the index.
SparseElement()
Construct uninitialized (value() == 0.0#, index() == 0#).
SparseElement(index_type index, value_type value)
Construct with a value and index set.
void initialize(index_type index, value_type value)
Initialize.