ROL
ROL_StdVector.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) 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 lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROL_STDVECTOR_H
45 #define ROL_STDVECTOR_H
46 
47 #include <algorithm>
48 #include <cstdlib>
49 
50 #include "ROL_Vector.hpp"
51 
57 namespace ROL {
58 
59 template <class Real, class Element=Real>
60 class StdVector : public Vector<Real> {
61 
62 private:
63 
64  Teuchos::RCP<std::vector<Element> > std_vec_;
65 
66 public:
67 
68  StdVector(const Teuchos::RCP<std::vector<Element> > & std_vec) : std_vec_(std_vec) {}
69 
70  void set( const Vector<Real> &x ) {
71  const StdVector &ex = Teuchos::dyn_cast<const StdVector>(x);
72  const std::vector<Element>& xval = *ex.getVector();
73  std::copy(xval.begin(),xval.end(),std_vec_->begin());
74  }
75 
76  void plus( const Vector<Real> &x ) {
77  const StdVector &ex = Teuchos::dyn_cast<const StdVector>(x);
78  const std::vector<Element>& xval = *ex.getVector();
79  unsigned dimension = std_vec_->size();
80  for (unsigned i=0; i<dimension; i++) {
81  (*std_vec_)[i] += xval[i];
82  }
83  }
84 
85  void scale( const Real alpha ) {
86  unsigned dimension = std_vec_->size();
87  for (unsigned i=0; i<dimension; i++) {
88  (*std_vec_)[i] *= alpha;
89  }
90  }
91 
92  Real dot( const Vector<Real> &x ) const {
93  const StdVector & ex = Teuchos::dyn_cast<const StdVector>(x);
94  const std::vector<Element>& xval = *ex.getVector();
95  unsigned dimension = std_vec_->size();
96  Real val = 0;
97  for (unsigned i=0; i<dimension; i++) {
98  val += (*std_vec_)[i]*xval[i];
99  }
100  return val;
101  }
102 
103  Real norm() const {
104  Real val = 0;
105  val = std::sqrt( dot(*this) );
106  return val;
107  }
108 
109  Teuchos::RCP<Vector<Real> > clone() const {
110  return Teuchos::rcp( new StdVector( Teuchos::rcp(new std::vector<Element>(std_vec_->size())) ));
111  }
112 
113  Teuchos::RCP<const std::vector<Element> > getVector() const {
114  return std_vec_;
115  }
116 
117  Teuchos::RCP<std::vector<Element> > getVector() {
118  return std_vec_;
119  }
120 
121  Teuchos::RCP<Vector<Real> > basis( const int i ) const {
122  Teuchos::RCP<StdVector> e = Teuchos::rcp( new StdVector( Teuchos::rcp(new std::vector<Element>(std_vec_->size(), 0.0)) ));
123  (*e->getVector())[i] = 1.0;
124  return e;
125  }
126 
127  int dimension() const {
128  return std_vec_->size();
129  }
130 
131 }; // class StdVector
132 
133 namespace StdVector_Helper {
134 
135 template<class Real>
136 Teuchos::RCP<const std::vector<Real> > constDownCast( const Vector<Real> &x ) {
137  return (Teuchos::dyn_cast<const StdVector<Real> >(x)).getVector();
138 }
139 
140 template<class Real>
141 Teuchos::RCP<std::vector<Real> > downCast( Vector<Real> &x ) {
142  return (Teuchos::dyn_cast<StdVector<Real> >(x)).getVector();
143 }
144 
145 } // namespace StdVector_Helper
146 
147 } // namespace ROL
148 
149 #endif
void scale(const Real alpha)
Compute where .
Teuchos::RCP< const std::vector< Element > > getVector() const
Real dot(const Vector< Real > &x) const
Compute where .
StdVector(const Teuchos::RCP< std::vector< Element > > &std_vec)
Teuchos::RCP< Vector< Real > > basis(const int i) const
Return i-th basis vector.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:72
Teuchos::RCP< std::vector< Element > > getVector()
Teuchos::RCP< Vector< Real > > clone() const
Clone to make a new (uninitialized) vector.
Real norm() const
Returns where .
Provides the std::vector implementation of the ROL::Vector interface.
void plus(const Vector< Real > &x)
Compute , where .
Teuchos::RCP< std::vector< Real > > downCast(Vector< Real > &x)
Teuchos::RCP< std::vector< Element > > std_vec_
int dimension() const
Return dimension of the vector space.
void set(const Vector< Real > &x)
Set where .
Teuchos::RCP< const std::vector< Real > > constDownCast(const Vector< Real > &x)