ROL
ROL_CplxStdVector.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_CPLXSTDVECTOR_H
45 #define ROL_CPLXSTDVECTOR_H
46 
47 #include <algorithm>
48 #include <complex>
49 #include <cstdlib>
50 
51 #include "ROL_Vector.hpp"
52 
60 namespace ROL {
61 
62 template<class Real, template<class> class complex>
63 class CplxStdVector : public Vector<Real> {
64 
65  typedef std::vector<complex<Real> > vector;
66  typedef Vector<Real> V;
67  typedef typename vector::size_type uint;
68 
69 private:
70 
71  Teuchos::RCP<vector> std_vec_;
72 
73 public:
74 
75  CplxStdVector(const Teuchos::RCP<vector> &std_vec) : std_vec_(std_vec) {}
76 
77  void set( const V &x ) {
78  const CplxStdVector &ex = Teuchos::dyn_cast<const CplxStdVector>(x);
79  const vector &xval = *ex.getVector();
80  std::copy(xval.begin(),xval.end(),std_vec_->begin());
81  }
82 
83  void plus( const V &x ) {
84  const CplxStdVector &ex = Teuchos::dyn_cast<const CplxStdVector>(x);
85  const vector& xval = *ex.getVector();
86  uint dimension = std_vec_->size();
87  for (uint i=0; i<dimension; i++) {
88  (*std_vec_)[i] += xval[i];
89  }
90  }
91 
92  void axpy( const Real alpha, const V &x ) {
93  const CplxStdVector &ex = Teuchos::dyn_cast<const CplxStdVector>(x);
94  const vector& xval = *ex.getVector();
95  uint dimension = std_vec_->size();
96  for (uint i=0; i<dimension; i++) {
97  (*std_vec_)[i] += alpha*xval[i];
98  }
99  }
100 
101  void scale( const Real alpha ) {
102  uint dimension = std_vec_->size();
103  for (uint i=0; i<dimension; i++) {
104  (*std_vec_)[i] *= alpha;
105  }
106  }
107 
108  complex<Real> dot( const V &x ) const {
109  const CplxStdVector & ex = Teuchos::dyn_cast<const CplxStdVector>(x);
110  const vector& xval = *ex.getVector();
111  uint dimension = std_vec_->size();
112  complex<Real> val = 0;
113  for (uint i=0; i<dimension; i++) {
114  val += (*std_vec_)[i]*std::conj(xval[i]);
115  }
116  return val;
117  }
118 
119  Real norm() const {
120  Real val = 0;
121  val = std::sqrt(std::abs(dot(*this)));
122  }
123 
124  Teuchos::RCP<V> clone() const {
125  return Teuchos::rcp( new StdVector( Teuchos::rcp(new std::vector<Element>(std_vec_->size())) ));
126  }
127 
128  Teuchos::RCP<const vector> getVector() const {
129  return std_vec_;
130  }
131 
132  Teuchos::RCP<vector> getVector() {
133  return std_vec_;
134  }
135 
136  Teuchos::RCP<V> basis( const int i ) const {
137  Teuchos::RCP<CplxStdVector> e = Teuchos::rcp( new CplxStdVector( Teuchos::rcp(new vector(std_vec_->size(), 0.0)) ));
138  (*e->getVector())[i] = 1.0;
139  return e;
140  }
141 
142  int dimension() const {
143  return static_cast<int>(std_vec_->size());
144  }
145 
146  Teuchos::RCP<V> dual() const {
147  uint dimension = std_vec_->size();
148  Teuchos::RCP<vector> x_rcp = Teuchos::rcp( new vector(dimension,0.0) );
149  for( uint i=0; i<dimension; ++i) {
150  (*x_rcp)[i] = std::conj( (*std_vec_)[i] );
151  }
152 
153  }
154 
155 
156  // Elementwise operations probably do not make sense in general here
157 
158 };
159 
160 } // namespace ROL
161 
162 #endif // ROL_CPLXSTDVECTOR_H
vector::size_type uint
Real norm() const
Returns where .
complex< Real > dot(const V &x) const
Compute where .
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:74
void scale(const Real alpha)
Compute where .
Teuchos::RCP< vector > std_vec_
Teuchos::RCP< V > dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis...
CplxStdVector(const Teuchos::RCP< vector > &std_vec)
Teuchos::RCP< vector > getVector()
Provides the std::vector implementation of the ROL::Vector interface.
void axpy(const Real alpha, const V &x)
Compute where .
Teuchos::RCP< const vector > getVector() const
int dimension() const
Return dimension of the vector space.
std::vector< complex< Real > > vector
Teuchos::RCP< V > basis(const int i) const
Return i-th basis vector.
Teuchos::RCP< V > clone() const
Clone to make a new (uninitialized) vector.
void plus(const V &x)
Compute , where .
Variant on ROL::StdVector with complex entries. Perhaps this can be accomplished with partial templat...