IterationPack: General framework for building iterative algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IterationPack_CastIQMember.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 CAST_IQ_MEMBER_H
43 #define CAST_IQ_MEMBER_H
44 
45 #include <limits.h>
46 
47 #include <typeinfo>
48 
49 #include "IterationPack_AlgorithmState.hpp"
50 #include "IterationPack_IterQuantityAccess.hpp"
51 
52 namespace IterationPack {
53 
59 public:
62  const std::string& iq_name() const;
65  bool exists_in( const AlgorithmState& s ) const;
66 protected:
68  CastIQMemberBase( const std::string iq_name );
70  void cache_iq_id( const AlgorithmState& s ) const;
72  void throw_cast_error( const AlgorithmState::iq_id_type iq_id, const std::string& iqa_name ) const;
74  const std::string iq_name_;
77 private:
78  enum { NOT_SET_YET = AlgorithmState::DOES_NOT_EXIST - 1 };
79  CastIQMemberBase(); // not defined and not to be called.
80 }; // end class CastIQMemberBase
81 
153 template < class T >
155 public:
157  CastIQMember( const std::string iq_name );
169  const IterQuantityAccess<T>& operator()( const AlgorithmState& s ) const;
170 private:
171  CastIQMember(); // not defined and not to be called
172 }; // end class CastIQMember<T>
173 
174 // //////////////////////////////////////////
175 // Definition of template members
176 
177 template < class T >
178 CastIQMember<T>::CastIQMember( const std::string iq_name )
179  : CastIQMemberBase(iq_name)
180 {}
181 
182 template < class T >
185 {
186  cache_iq_id(s);
187  if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
188  throw_cast_error(iq_id_,TypeNameTraits<T>::name());
190  *p = dynamic_cast<IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
191  if( !p )
192  throw_cast_error(iq_id_,TypeNameTraits<T>::name());
193  return *p;
194 }
195 
196 template < class T >
199 {
200  cache_iq_id(s);
201  if( iq_id_ == AlgorithmState::DOES_NOT_EXIST )
202  throw_cast_error(iq_id_,TypeNameTraits<T>::name());
204  *p = dynamic_cast<const IterQuantityAccess<T>*>( &s.iter_quant( iq_id_ ) );
205  if( !p )
206  throw_cast_error(iq_id_,TypeNameTraits<T>::name());
207  return *p;
208 }
209 
210 } // namespace IterationPack
211 
212 #endif // CAST_IQ_MEMBER_H
IterQuantityAccess< T > & operator()(AlgorithmState &s) const
Get the iteration quantity from an AlgorithmState object.
void cache_iq_id(const AlgorithmState &s) const
Template class to be used to lookup an interation quantity, cast it to an IterQuantityAccess<T> objec...
Interface to typed iteration quantities.
bool exists_in(const AlgorithmState &s) const
Returns if the iteration quantity exists in the state object.
const std::string & iq_name() const
Name returns the name of the iteration quantity.
virtual IterQuantity & iter_quant(const std::string &iq_name)
Iteration quantity encapsulation object access with via iq_name.
Abstacts a set of iteration quantities for an iterative algorithm.
Base class for some of the implementation features of CastIQMember.
void throw_cast_error(const AlgorithmState::iq_id_type iq_id, const std::string &iqa_name) const