ROL
Public Member Functions | Private Types | Private Attributes | List of all members
OptStdVector< Real, Element > Class Template Reference

#include <example_02.hpp>

Public Member Functions

 OptStdVector (const ROL::Ptr< std::vector< Element > > &std_vec)
 
void plus (const ROL::Vector< Real > &x)
 
void scale (const Real alpha)
 
Real dot (const ROL::Vector< Real > &x) const
 
Real norm () const
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 
ROL::Ptr< const std::vector< Element > > getVector () const
 
ROL::Ptr< std::vector< Element > > getVector ()
 
ROL::Ptr< ROL::Vector< Real > > basis (const int i) const
 
int dimension () const
 
const ROL::Vector< Real > & dual () const
 
 OptStdVector (const ROL::Ptr< std::vector< Element > > &std_vec)
 
void plus (const ROL::Vector< Real > &x)
 
void scale (const Real alpha)
 
Real dot (const ROL::Vector< Real > &x) const
 
Real norm () const
 
ROL::Ptr< ROL::Vector< Real > > clone () const
 
ROL::Ptr< const std::vector< Element > > getVector () const
 
ROL::Ptr< std::vector< Element > > getVector ()
 
ROL::Ptr< ROL::Vector< Real > > basis (const int i) const
 
int dimension () const
 
const ROL::Vector< Real > & dual () const
 
 OptStdVector (const ROL::Ptr< std::vector< Element > > &std_vec, ROL::Ptr< FiniteDifference< Real > >fd)
 
void plus (const Vector< Real > &x)
 
void scale (const Real alpha)
 
Real dot (const Vector< Real > &x) const
 Modify the dot product between primal variables to be \((u,v)=\int\limits_0^1 \dot u \dot v\,\mathrm{d}x \). More...
 
Real norm () const
 
ROL::Ptr< Vector< Real > > clone () const
 
ROL::Ptr< const vectorgetVector () const
 
ROL::Ptr< vectorgetVector ()
 
ROL::Ptr< Vector< Real > > basis (const int i) const
 
int dimension () const
 
const Vector< Real > & dual () const
 Modify the dual of vector u to be \(\tilde u = -\ddot u\). More...
 

Private Types

typedef std::vector< Element > vector
 
typedef ROL::Vector< Real > V
 
typedef vector::size_type uint
 
typedef std::vector< Element > vector
 
typedef ROL::Vector< Real > V
 
typedef vector::size_type uint
 
typedef std::vector< Element > vector
 
typedef vector::size_type uint
 

Private Attributes

ROL::Ptr< std::vector< Element > > std_vec_
 
ROL::Ptr< OptDualStdVector< Real > > dual_vec_
 
ROL::Ptr< FiniteDifference< Real > > fd_
 

Detailed Description

template<class Real, class Element>
class OptStdVector< Real, Element >

Definition at line 117 of file gross-pitaevskii/example_02.hpp.

Member Typedef Documentation

◆ vector [1/3]

template<class Real , class Element >
typedef std::vector<Element> OptStdVector< Real, Element >::vector
private

Definition at line 78 of file dual-spaces/rosenbrock-1/example_01.cpp.

◆ V [1/2]

template<class Real , class Element >
typedef ROL::Vector<Real> OptStdVector< Real, Element >::V
private

Definition at line 79 of file dual-spaces/rosenbrock-1/example_01.cpp.

◆ uint [1/3]

template<class Real , class Element >
typedef vector::size_type OptStdVector< Real, Element >::uint
private

Definition at line 81 of file dual-spaces/rosenbrock-1/example_01.cpp.

◆ vector [2/3]

template<class Real , class Element >
typedef std::vector<Element> OptStdVector< Real, Element >::vector
private

◆ V [2/2]

template<class Real , class Element >
typedef ROL::Vector<Real> OptStdVector< Real, Element >::V
private

◆ uint [2/3]

template<class Real , class Element >
typedef vector::size_type OptStdVector< Real, Element >::uint
private

◆ vector [3/3]

template<class Real , class Element >
typedef std::vector<Element> OptStdVector< Real, Element >::vector
private

Definition at line 119 of file gross-pitaevskii/example_02.hpp.

◆ uint [3/3]

template<class Real , class Element >
typedef vector::size_type OptStdVector< Real, Element >::uint
private

Definition at line 120 of file gross-pitaevskii/example_02.hpp.

Constructor & Destructor Documentation

◆ OptStdVector() [1/3]

template<class Real , class Element >
OptStdVector< Real, Element >::OptStdVector ( const ROL::Ptr< std::vector< Element > > &  std_vec)
inline

Definition at line 89 of file dual-spaces/rosenbrock-1/example_01.cpp.

◆ OptStdVector() [2/3]

template<class Real , class Element >
OptStdVector< Real, Element >::OptStdVector ( const ROL::Ptr< std::vector< Element > > &  std_vec)
inline

◆ OptStdVector() [3/3]

template<class Real , class Element >
OptStdVector< Real, Element >::OptStdVector ( const ROL::Ptr< std::vector< Element > > &  std_vec,
ROL::Ptr< FiniteDifference< Real > >  fd 
)
inline

Definition at line 131 of file gross-pitaevskii/example_02.hpp.

Member Function Documentation

◆ plus() [1/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::plus ( const ROL::Vector< Real > &  x)
inline

◆ scale() [1/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::scale ( const Real  alpha)
inline

◆ dot() [1/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::dot ( const ROL::Vector< Real > &  x) const
inline

◆ norm() [1/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::norm ( void  ) const
inline

Definition at line 118 of file dual-spaces/rosenbrock-1/example_01.cpp.

References OptStdVector< Real, Element >::dot().

Referenced by main().

◆ clone() [1/3]

template<class Real , class Element >
ROL::Ptr<ROL::Vector<Real> > OptStdVector< Real, Element >::clone ( void  ) const
inline

◆ getVector() [1/6]

template<class Real , class Element >
ROL::Ptr<const std::vector<Element> > OptStdVector< Real, Element >::getVector ( void  ) const
inline

◆ getVector() [2/6]

template<class Real , class Element >
ROL::Ptr<std::vector<Element> > OptStdVector< Real, Element >::getVector ( void  )
inline

◆ basis() [1/3]

template<class Real , class Element >
ROL::Ptr<ROL::Vector<Real> > OptStdVector< Real, Element >::basis ( const int  i) const
inline

◆ dimension() [1/3]

template<class Real , class Element >
int OptStdVector< Real, Element >::dimension ( void  ) const
inline

◆ dual() [1/3]

template<class Real , class Element >
const ROL::Vector<Real>& OptStdVector< Real, Element >::dual ( void  ) const
inline

◆ plus() [2/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::plus ( const ROL::Vector< Real > &  x)
inline

◆ scale() [2/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::scale ( const Real  alpha)
inline

◆ dot() [2/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::dot ( const ROL::Vector< Real > &  x) const
inline

◆ norm() [2/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::norm ( void  ) const
inline

◆ clone() [2/3]

template<class Real , class Element >
ROL::Ptr<ROL::Vector<Real> > OptStdVector< Real, Element >::clone ( void  ) const
inline

◆ getVector() [3/6]

template<class Real , class Element >
ROL::Ptr<const std::vector<Element> > OptStdVector< Real, Element >::getVector ( void  ) const
inline

◆ getVector() [4/6]

template<class Real , class Element >
ROL::Ptr<std::vector<Element> > OptStdVector< Real, Element >::getVector ( void  )
inline

◆ basis() [2/3]

template<class Real , class Element >
ROL::Ptr<ROL::Vector<Real> > OptStdVector< Real, Element >::basis ( const int  i) const
inline

◆ dimension() [2/3]

template<class Real , class Element >
int OptStdVector< Real, Element >::dimension ( void  ) const
inline

◆ dual() [2/3]

template<class Real , class Element >
const ROL::Vector<Real>& OptStdVector< Real, Element >::dual ( void  ) const
inline

◆ plus() [3/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::plus ( const Vector< Real > &  x)
inline

◆ scale() [3/3]

template<class Real , class Element >
void OptStdVector< Real, Element >::scale ( const Real  alpha)
inline

Definition at line 143 of file gross-pitaevskii/example_02.hpp.

◆ dot() [3/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::dot ( const Vector< Real > &  x) const
inline

Modify the dot product between primal variables to be \((u,v)=\int\limits_0^1 \dot u \dot v\,\mathrm{d}x \).

Definition at line 152 of file gross-pitaevskii/example_02.hpp.

References OptStdVector< Real, Element >::getVector().

◆ norm() [3/3]

template<class Real , class Element >
Real OptStdVector< Real, Element >::norm ( void  ) const
inline

Definition at line 168 of file gross-pitaevskii/example_02.hpp.

◆ clone() [3/3]

template<class Real , class Element >
ROL::Ptr<Vector<Real> > OptStdVector< Real, Element >::clone ( void  ) const
inline

Definition at line 174 of file gross-pitaevskii/example_02.hpp.

◆ getVector() [5/6]

template<class Real , class Element >
ROL::Ptr<const vector> OptStdVector< Real, Element >::getVector ( void  ) const
inline

Definition at line 178 of file gross-pitaevskii/example_02.hpp.

◆ getVector() [6/6]

template<class Real , class Element >
ROL::Ptr<vector> OptStdVector< Real, Element >::getVector ( void  )
inline

Definition at line 182 of file gross-pitaevskii/example_02.hpp.

◆ basis() [3/3]

template<class Real , class Element >
ROL::Ptr<Vector<Real> > OptStdVector< Real, Element >::basis ( const int  i) const
inline

Definition at line 186 of file gross-pitaevskii/example_02.hpp.

◆ dimension() [3/3]

template<class Real , class Element >
int OptStdVector< Real, Element >::dimension ( void  ) const
inline

Definition at line 193 of file gross-pitaevskii/example_02.hpp.

◆ dual() [3/3]

template<class Real , class Element >
const Vector<Real>& OptStdVector< Real, Element >::dual ( void  ) const
inline

Modify the dual of vector u to be \(\tilde u = -\ddot u\).

Definition at line 197 of file gross-pitaevskii/example_02.hpp.

Member Data Documentation

◆ std_vec_

template<class Real , class Element >
ROL::Ptr< std::vector< Element > > OptStdVector< Real, Element >::std_vec_
private

◆ dual_vec_

template<class Real , class Element >
ROL::Ptr< OptDualStdVector< Real > > OptStdVector< Real, Element >::dual_vec_
mutableprivate

◆ fd_

template<class Real , class Element >
ROL::Ptr<FiniteDifference<Real> > OptStdVector< Real, Element >::fd_
private

Definition at line 126 of file gross-pitaevskii/example_02.hpp.


The documentation for this class was generated from the following files: