In this Page, we manage the options for the computation of the LocalVariance. More...

#include <STK_LocalVariancePage.h>

Inheritance diagram for STK::LocalVariancePage:

Public Member Functions
	LocalVariancePage ()
	default constructor

	LocalVariancePage (int const &level)
	constructor with a given level.

	LocalVariancePage (LocalVariancePage const &page)
	copy constructor.

virtual	~LocalVariancePage ()
	destructor.

virtual LocalVariancePage *	clone () const
	clone pattern

Reduct::TypeGraph	typeGraph () const
	get the type of graph

int	nbNeighbor () const

virtual bool	validate ()
	validate the options.

Public Member Functions inherited from STK::IPage
	IPage (String const &name, int const &level, bool isOptional)
	Constructor.

	IPage (IPage const &page)
	Copy constructor.

virtual	~IPage ()
	Destructor.

String const &	name () const
	name of the IPage.

bool	isOptional () const
	is this Option optional ?.

ContOption const &	options () const
	get the options of the IPage

String const &	msg_error () const
	name of the IPage.

Option &	option (String const &name)
	bookkeeping function.

Option const &	option (String const &name) const
	bookkeeping function.

Option const &	option (int const &pos) const
	get the ith constant option of the IPage

Option &	option (int const &pos)
	get the ith option of the IPage

Option const &	operator[] (int const &pos) const
	get the ith constant option of the IPage

Option &	operator[] (int const &pos)
	get the ith option of the IPage

void	addOption (Option const &opt)
	add an option to the page

void	addPage (IPage const &page)
	add a sub-page as an option to the page

void	read (istream &is)
	read in options from an input steam stream

void	write (ostream &os) const
	write out options in a stream

Private Attributes
Reduct::TypeGraph	type_
	type of the graph to compute

int	nbNeighbor_
	number of neighbors of each individual in the graph.

Additional Inherited Members
Public Types inherited from STK::IPage
typedef std::vector< Option >	ContOption
	Container for the options.

Protected Attributes inherited from STK::IPage
bool	isOptional_
	`true` if the Page is optinal, `false` otherwise

ContOption	options_
	array of the options

String	msg_error_
	Contain the last error message.

Detailed Description

In this Page, we manage the options for the computation of the LocalVariance.

The LocalVariance page have the form

 # LocalVariancePage options
[LocalVariance]
  # proximity graph type using prim or distance
  type graph = distance
  # number of neighbors to use
  neighborhood = 2

Definition at line 58 of file STK_LocalVariancePage.h.

Constructor & Destructor Documentation

◆ LocalVariancePage() [1/3]

STK::LocalVariancePage::LocalVariancePage ( )

default constructor

Definition at line 50 of file STK_LocalVariancePage.cpp.

                                    : IPage(_T("LocalVariance"), 1, true)
                                    , type_(Reduct::distance_)
                                    , nbNeighbor_(3)
{
  // reserve for the 2 options
  options_.reserve(2);
  // first option : type of graph
  options_.push_back(Option(_T("type graph"), Option::string_, true));
  options_.back().setValue(_T("minimalDistance"));
  // number of neighbor
  options_.push_back(Option(_T("neighborhood"), Option::integer_, true));
  options_.back().setValue(_T("3"));
}

References _T, STK::Option::integer_, STK::IPage::options_, and STK::Option::string_.

Referenced by clone().

◆ LocalVariancePage() [2/3]

STK::LocalVariancePage::LocalVariancePage ( int const & level )

constructor with a given level.

Parameters

level the level of the page

Definition at line 66 of file STK_LocalVariancePage.cpp.

                                    : IPage(_T("LocalVariance"), level, true)
                                    , type_(Reduct::distance_)
                                    , nbNeighbor_(2)
{
  // reserve for the 2 options
  options_.reserve(2);
  // first option : type of graph
  options_.push_back(Option(_T("type graph"), Option::string_, true));
  options_.back().setValue(_T("minimalDistance"));
  // number of neighbor
  options_.push_back(Option(_T("neighborhood"), Option::integer_, true));
  options_.back().setValue(_T("2"));
}

References _T, STK::Option::integer_, STK::IPage::options_, and STK::Option::string_.

◆ LocalVariancePage() [3/3]

STK::LocalVariancePage::LocalVariancePage ( LocalVariancePage const & page )

copy constructor.

Parameters

page	the page to copy

Definition at line 82 of file STK_LocalVariancePage.cpp.

                                    : IPage(page)
                                    , type_(page.type_)
                                    , nbNeighbor_(page.nbNeighbor_)
{}

◆ ~LocalVariancePage()

STK::LocalVariancePage::~LocalVariancePage ( )

virtual

destructor.

Definition at line 89 of file STK_LocalVariancePage.cpp.

90{}

Member Function Documentation

◆ clone()

virtual LocalVariancePage * STK::LocalVariancePage::clone ( ) const

inlinevirtual

clone pattern

Returns: a pointer on the clone of this

Reimplemented from STK::IPage.

Definition at line 76 of file STK_LocalVariancePage.h.

77 { return new LocalVariancePage(*this);}

STK::LocalVariancePage::LocalVariancePage

LocalVariancePage()

default constructor

Definition STK_LocalVariancePage.cpp:50

References LocalVariancePage().

◆ nbNeighbor()

int STK::LocalVariancePage::nbNeighbor ( ) const

inline

Returns: the number of neighbors to used in order to construct the proximity graph

Definition at line 86 of file STK_LocalVariancePage.h.

86{ return nbNeighbor_;}

References nbNeighbor_.

◆ typeGraph()

Reduct::TypeGraph STK::LocalVariancePage::typeGraph ( ) const

inline

get the type of graph

Returns: the TypeGraph used for computing the local variance

Definition at line 82 of file STK_LocalVariancePage.h.

82{ return type_;}

References type_.

◆ validate()

bool STK::LocalVariancePage::validate ( )

virtual

validate the options.

Check if the values are coherent.

Returns: true if the options are correct, false otherwise.

Reimplemented from STK::IPage.

Definition at line 92 of file STK_LocalVariancePage.cpp.

{
  // validate first option
  type_ = Reduct::stringToTypeGraph(options_[0].get(String()));
  if (type_ == Reduct::unknown_graph_ )
  {
    msg_error_ = LOCALVARIANCEERRORCODES[1];
    msg_error_ += "graph type unknown.\n";
    return false;
  }
  // validate second option
  nbNeighbor_ = options_[1].get(int());
  if (nbNeighbor_ <= 0)
  {
    msg_error_ = LOCALVARIANCEERRORCODES[1];
    msg_error_ += "neighborhood must be a strictly positive value.\n";
    return false;
  }
  return true;
}

References STK::IPage::msg_error_, nbNeighbor_, STK::IPage::options_, STK::Reduct::stringToTypeGraph(), type_, and STK::Reduct::unknown_graph_.

Member Data Documentation

◆ nbNeighbor_

int STK::LocalVariancePage::nbNeighbor_

private

number of neighbors of each individual in the graph.

Definition at line 96 of file STK_LocalVariancePage.h.

Referenced by nbNeighbor(), and validate().

◆ type_

Reduct::TypeGraph STK::LocalVariancePage::type_

private

type of the graph to compute

Definition at line 94 of file STK_LocalVariancePage.h.

Referenced by typeGraph(), and validate().

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

Public Member Functions

Private Attributes

Additional Inherited Members