ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_MeritFuncPenaltyParams.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 MERIT_FUNC_PENALTY_PARAMS_H
43 #define MERIT_FUNC_PENALTY_PARAMS_H
44 
45 #include "ConstrainedOptPack_Types.hpp"
46 #include "AbstractLinAlgPack_VectorSpace.hpp"
47 
48 namespace ConstrainedOptPack {
49 
54 public:
55 
57  class CanNotResize : public std::logic_error
58  {public: CanNotResize(const std::string& what_arg) : std::logic_error(what_arg) {}};
59 
62 
65 
68  virtual void set_space_c( const VectorSpace::space_ptr_t& space_c ) = 0;
69 
71  virtual VectorMutable& set_mu() = 0;
72 
74  virtual const Vector& get_mu() const = 0;
75 
77 
78 }; // end class MeritFuncPenaltyParams
79 
80 } // end namespace ConstrainedOptPack
81 
82 #endif // MERIT_FUNC_PENALTY_PARAMS_H
virtual void set_space_c(const VectorSpace::space_ptr_t &space_c)=0
Set the vector space for to use for the penalty parameters.
This class provides interface for setting and retrieving a penalty parameter that many merit function...
virtual const Vector & get_mu() const =0
Get the vector of penalty parameters for viewing them.
virtual VectorMutable & set_mu()=0
Get the vector of penalty parameters for setting them.