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.cpp
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 #include <string>
43 #include <sstream>
44 
45 #include "IterationPack_CastIQMember.hpp"
46 #include "Teuchos_Assert.hpp"
47 
48 namespace IterationPack {
49 
50 CastIQMemberBase::CastIQMemberBase( const std::string iq_name )
51  : iq_name_(iq_name), iq_id_(NOT_SET_YET)
52 {}
53 
54 const std::string&
56 {
57  return iq_name_;
58 }
59 
60 bool
62 {
63  cache_iq_id(s);
64  return iq_id_ != AlgorithmState::DOES_NOT_EXIST;
65 }
66 
68 {
69  if( iq_id_ == NOT_SET_YET ) {
71  }
72 }
73 
74 void CastIQMemberBase::throw_cast_error( const AlgorithmState::iq_id_type iq_id, const std::string& iqa_name ) const
75 {
77  iq_id == AlgorithmState::DOES_NOT_EXIST, AlgorithmState::DoesNotExist
78  ,"CastIQMember<T>::operator()(...) : Error, the iteration quantity \""
79  << iq_name_ << "\" does not exist in this state object." );
82  ,"CastIQMember<T>::operator()(state) : Error, the iteration quantity \""
83  << iq_name_ << "\" exists but it is not of the type IterQuantityAccess<"
84  << iqa_name << ">" );
85 }
86 
87 } // namespace IterationPack
void cache_iq_id(const AlgorithmState &s) const
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
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.
Abstacts a set of iteration quantities for an iterative algorithm.
virtual iq_id_type get_iter_quant_id(const std::string &iq_name) const
Return the iteration quantity id (iq_id) for the iteration quantity.
void throw_cast_error(const AlgorithmState::iq_id_type iq_id, const std::string &iqa_name) const