olb::opti::Controller< S > Class Template Reference

#include <controller.h>

Inheritance diagram for olb::opti::Controller< S >:

Collaboration diagram for olb::opti::Controller< S >:

Public Member Functions
	Controller (int dimControl)
	Controller (std::vector< S > &initialValues)
S const &	getControl (int i) const
S &	getControl (int i)
const std::vector< S > &	getControl ()
int	getDimControl () const
void	setControl (const std::vector< S > &control, int dimControl)
void	print ()
void	writeToFile (const char *fname=nullptr)
void	readFromFile (const char *fname)

Protected Attributes
int	_dimControl
std::vector< S >	_control

Detailed Description

template<typename S>
class olb::opti::Controller< S >

Definition at line 43 of file controller.h.

Constructor & Destructor Documentation

Controller() [1/2]

template<typename S >

olb::opti::Controller< S >::Controller ( int dimControl )

inline

Definition at line 50 of file controller.h.

   : _dimControl (dimControl),
     _control (dimControl, 0.0)
  { }

Controller() [2/2]

template<typename S >

olb::opti::Controller< S >::Controller ( std::vector< S > & initialValues )

inline

Definition at line 55 of file controller.h.

   : _dimControl(initialValues.size()), _control(initialValues)
  { }

Member Function Documentation

getControl() [1/3]

template<typename S >

const std::vector< S > & olb::opti::Controller< S >::getControl ( )

inline

Definition at line 67 of file controller.h.

  {
    return _control;
  };

References olb::opti::Controller< S >::_control.

getControl() [2/3]

template<typename S >

S & olb::opti::Controller< S >::getControl ( int i )

inline

Definition at line 63 of file controller.h.

  {
    return _control[i];
  };

References olb::opti::Controller< S >::_control.

getControl() [3/3]

template<typename S >

S const & olb::opti::Controller< S >::getControl ( int i ) const

inline

Definition at line 59 of file controller.h.

  {
    return _control[i];
  };

References olb::opti::Controller< S >::_control.

Here is the caller graph for this function:

getDimControl()

template<typename S >

int olb::opti::Controller< S >::getDimControl ( ) const

inline

Definition at line 72 of file controller.h.

  {
    return _dimControl;
  };

References olb::opti::Controller< S >::_dimControl.

print()

template<typename S >

void olb::opti::Controller< S >::print ( )

inline

Definition at line 83 of file controller.h.

  {
    static OstreamManager clout(std::cout,"Controller");
 
    clout << " control={ ";
    for (int i=0; i<_dimControl; i++) {
      clout << _control[i] << " ";
    }
    clout << "}" << std::endl;
 
  };

References olb::opti::Controller< S >::_control, and olb::opti::Controller< S >::_dimControl.

readFromFile()

template<typename S >

void olb::opti::Controller< S >::readFromFile ( const char * fname )

inline

Definition at line 116 of file controller.h.

  {
    static OstreamManager clout(std::cout,"Controller");
    std::ifstream file;
    //    if (file.open(fname)) {
    file.open(fname);
    int dim;
    file >> dim;
    if (dim!=_dimControl) {
      clout << "Error: dimensions do not match! dim_controller=" << _dimControl << "; dim_file=" << dim << std::endl;
      assert(false);
    }
    else {
      for (int i=0; i<_dimControl; i++) {
        double tmpVal;
        file >> tmpVal;
        _control[i]  = tmpVal;
      }
    }
    file.close();
    //    }
  }

References olb::opti::Controller< S >::_control, and olb::opti::Controller< S >::_dimControl.

setControl()

template<typename S >

void olb::opti::Controller< S >::setControl ( const std::vector< S > & control, int dimControl )

inline

Definition at line 77 of file controller.h.

  {
    _control = control;
    _dimControl = dimControl;
  };

References olb::opti::Controller< S >::_control, olb::opti::Controller< S >::_dimControl, and olb::opti::control.

writeToFile()

template<typename S >

void olb::opti::Controller< S >::writeToFile ( const char * fname = nullptr )

inline

Definition at line 95 of file controller.h.

  {
    static OstreamManager clout(std::cout,"Controller");
    std::ofstream file;
    if (fname==nullptr) {
      static int iter(0);
      std::stringstream number;
      number << std::setw(3) << std::setfill('0') << iter++;
      file.open(("Controller" + number.str() + ".txt").c_str());
    }
    else {
      file.open(fname);
    }
 
    file << _dimControl << std::endl;
    for (int i=0; i<_dimControl; i++) {
      file << _control[i] << std::endl;
    }
    file.close();
  };

References olb::opti::Controller< S >::_control, and olb::opti::Controller< S >::_dimControl.

Member Data Documentation

_control

template<typename S >

std::vector<S> olb::opti::Controller< S >::_control

protected

Definition at line 47 of file controller.h.

_dimControl

template<typename S >

int olb::opti::Controller< S >::_dimControl

protected

Definition at line 46 of file controller.h.

---

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

• src/optimization/controller.h