IterationPack: General framework for building iterative algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IterationPack_IterQuantityAccess.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 ITER_QUANTITY_ACCESS_H
43 #define ITER_QUANTITY_ACCESS_H
44 
45 #include "IterationPack_IterQuantity.hpp"
46 
47 namespace IterationPack {
48 
109 template<class T_info>
111 public:
112 
117 
128  virtual T_info& get_k(int offset) = 0;
129 
139  virtual const T_info& get_k(int offset) const = 0;
140 
169  virtual T_info& set_k(int offset) = 0;
170 
198  virtual T_info& set_k(int set_offset, int get_offset) = 0;
199 
200 }; // end class IterQuantityAccess
201 
202 } // end namespace IterationPack
203 
204 #endif // ITER_QUANTITY_ACCESS_H
IterQuantity::NoStorageAvailable NoStorageAvailable
Interface to typed iteration quantities.
virtual T_info & get_k(int offset)=0
Return a reference for the k + offset iteration quanity.
Thrown when memory access is attempted when it has not yet been updated.
Thrown memory if attempted to be set that storage can not be allocated to.
Iterface for information about Iteration Quantities.
virtual T_info & set_k(int offset)=0
Return a reference to the storage location for the k + offset iteration quanity.