toroidal Class Reference

This class defines the toroidal search controller. More...

#include <toroidal.h>

Inheritance diagram for toroidal:

Collaboration diagram for toroidal:

Public Member Functions
virtual void	addvar (std::weak_ptr< variable > v)
	Adds a variable to the controller.
virtual std::vector< std::string >	dependencies () const
virtual void	postprocess (input &inval)
virtual std::string	type () const
virtual void	control (comp *u, objective *obj)
virtual char	is_good ()
	Returns whether the controller is done or not.
virtual int	pre_set ()
	Moves the controller through fake iterations if the starting index is greater than 1.

Private Attributes
size_t	iterations
size_t	num_int
double	initial_inc
double	mul_fac

Additional Inherited Members
Static Public Member Functions inherited from item
static std::shared_ptr< item >	create (std::string name, engineimp *rval)
Public Attributes inherited from controller
int	index
size_t	num_cont
Protected Member Functions inherited from item_dim
void	print_upstream ()
virtual void	_do_mem_update (size_t dim_old)
void	add_as_parent (item_dim *p)
void	add_as_parent (std::shared_ptr< item_dim > p)
void	update_dim (size_t dim_new)
Protected Attributes inherited from controller
std::vector< std::weak_ptr < variable > >	vars
int	act_index

Detailed Description

This class defines the toroidal search controller.

This class defines a controller that can be used for searching a toroidal parameter space It increments a set of variables at specified increments a set number of times. In the future, this class will also be able to perform searches until the parameter space has been successfully examined

Definition at line 27 of file toroidal.h.

Member Function Documentation

void toroidal::addvar ( std::weak_ptr< variable >  v )

virtual

Adds a variable to the controller.

Implements controller.

Definition at line 109 of file toroidal.cpp.

void toroidal::control ( comp *  u, objective *  obj  )

virtual

Implements controller.

Definition at line 82 of file toroidal.cpp.

std::vector< std::string > toroidal::dependencies ( ) const

virtual

Reimplemented from controller.

Definition at line 34 of file toroidal.cpp.

Here is the call graph for this function:

char toroidal::is_good ( )

virtual

Returns whether the controller is done or not.

Implements controller.

Definition at line 113 of file toroidal.cpp.

void toroidal::postprocess ( input &  dat )

virtual

Performs the postprocessing for toroidal, which is setting the number of iterations that are to be performed

Parameters

dat	Map containing the input values

See Also

controller::postprocess, item_dim::postprocess

Reimplemented from controller.

Definition at line 46 of file toroidal.cpp.

Here is the call graph for this function:

int toroidal::pre_set ( )

virtual

Moves the controller through fake iterations if the starting index is greater than 1.

Implements controller.

Definition at line 117 of file toroidal.cpp.

std::string toroidal::type ( ) const

virtual

Returns the type of the class toroidal

Returns

Returns the type of the toroidal class, "toroidal"

Implements controller.

Definition at line 78 of file toroidal.cpp.

Member Data Documentation

double toroidal::initial_inc

private

Definition at line 30 of file toroidal.h.

size_t toroidal::iterations

private

Definition at line 28 of file toroidal.h.

double toroidal::mul_fac

private

Definition at line 31 of file toroidal.h.

size_t toroidal::num_int

private

Definition at line 29 of file toroidal.h.

---

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

• controller/toroidal.h
• controller/toroidal.cpp