sspace::param_t Class Reference

#include <types.hpp>

Inheritance diagram for sspace::param_t:

Public Member Functions
	param_t (std::string n, pt t)
virtual	~param_t ()
virtual pt	get_type ()
virtual std::string	get_name ()

Private Attributes
const std::string	m_name
const pt	m_type

Detailed Description

param_t is the base parameter class which all other parameters in the search space implement.

Constructor & Destructor Documentation

param_t()

sspace::param_t::param_t	(	std::string	n,
		pt	t
	)

base constructor

Parameters

n	The name of the parameter

~param_t()

virtual sspace::param_t::~param_t ( )

inlinevirtual

A virtual destructor is required here so that pointers to derived classes can be deleted.

Member Function Documentation

get_name()

virtual std::string sspace::param_t::get_name ( )

inlinevirtual

All parameters must also be named.

Returns

this parameter's name

get_type()

virtual pt sspace::param_t::get_type ( )

inlinevirtual

Every parameter has a fixed type corresponding to pt::param_type

Returns

the type of this parameter.

---

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

• includes/optk/types.hpp
• src/types.cpp