NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
NLPInterfacePack_NLPDirect.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 <assert.h>
43 
44 #include "NLPInterfacePack_NLPDirect.hpp"
45 #include "AbstractLinAlgPack_MatrixOp.hpp"
46 #include "AbstractLinAlgPack_VectorSpace.hpp"
47 #include "Teuchos_Assert.hpp"
48 
49 namespace NLPInterfacePack {
50 
51 // NLPDirect
52 
54  const mat_sym_fcty_ptr_t &factory_transDtD
55  ,const mat_sym_nonsing_fcty_ptr_t &factory_S
56  )
57 {
58  factory_transDtD_ = factory_transDtD;
59  factory_S_ = factory_S;
60 }
61 
63 {
64  return this->con_decomp().size();
65 }
66 
67 Range1D NLPDirect::var_dep() const
68 {
69  return Range1D(1,m());
70 }
71 Range1D NLPDirect::var_indep() const
72 {
73  return Range1D(m()+1,n());
74 }
75 Range1D NLPDirect::con_decomp() const
76 {
77  return Range1D(1,m());
78 }
79 
80 Range1D NLPDirect::con_undecomp() const
81 {
82  return Range1D::Invalid;
83 }
84 
87 {
88  return Teuchos::null;
89 }
90 
93 {
94  return Teuchos::null;
95 }
96 
99 {
100  return Teuchos::null;
101 }
102 
105 {
106  return factory_transDtD_;
107 }
108 
111 {
112  return factory_S_;
113 }
114 
115 void NLPDirect::initialize(bool test_setup)
116 {
117  NLPObjGrad::initialize(test_setup);
118 }
119 
120 } // end namespace NLPIntefacePack
void initialize(bool test_setup)
Initialize the NLP for its first use.
virtual Range1D con_decomp() const
Return the range of decomposed equality constraints.
virtual const mat_fcty_ptr_t factory_GcU() const
Return a matrix factory object for creating GcU.
virtual const mat_fcty_ptr_t factory_Uz() const
Return a matrix factory object for Uz = F + E * D.
void set_factories(const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S)
Initialize the factory objects for the special matrices for D'*D and S = I + D'*D.
virtual size_type r() const
Returns the number of decomposed equality constraints (r <= m).
virtual const mat_fcty_ptr_t factory_GcUD() const
Return a matrix factory object for a mutable matrix compatible with GcU(var_dep). ...
virtual const mat_sym_fcty_ptr_t factory_transDtD() const
Returns a matrix factory for the result of J = D'*D
virtual Range1D con_undecomp() const
Return the range of undecomposed equality constraints.
void initialize(bool test_setup)
Initialize the NLP for its first use.
virtual size_type n() const
Return the number of variables.
size_t size_type
virtual Range1D var_dep() const
Return the range of dependent (i.e. basic) variables.
virtual Range1D var_indep() const
Return the range of independent (i.e. nonbasic) variables.
virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const
Returns a matrix factory for the result of S = I + D'*D
virtual size_type m() const
Return the number of general equality constraints.