ParameterScorePair Class Reference

A container which holds a set of parameters and an associated scalar score value. More...

#include <ParameterScorePair.h>

List of all members.

Public Member Functions
	ParameterScorePair ()
	Creates an uninitialized instance of this class with no allocated memory.
	ParameterScorePair (QMCObjectiveFunctionResult score, Array1D< double > &parameters)
	Creates an uninitialized instance of this class and sets the score and parameter values.
	ParameterScorePair (const ParameterScorePair &PSP)
	Creates an instance of this class which is equal to another instance.
double	getScore () const
	Gets the score.
Array1D< double > *	getParameters ()
	Gets the parameters.
void	operator= (const ParameterScorePair &rhs)
	Set two ParameterScorePair objects equal.
bool	operator< (const ParameterScorePair &PSP) const
	An operator which orders ParameterScorePair objects based on their scores.
Private Attributes
QMCObjectiveFunctionResult	Score
Array1D< double >	Parameters
Friends
ostream &	operator<< (ostream &strm, const ParameterScorePair &rhs)
	Prints the contents of this object in a human readable format.

---

Detailed Description

A container which holds a set of parameters and an associated scalar score value.

Definition at line 25 of file ParameterScorePair.h.

---

Constructor & Destructor Documentation

ParameterScorePair::ParameterScorePair

(

)

Creates an uninitialized instance of this class with no allocated memory.

Definition at line 15 of file ParameterScorePair.cpp.

ParameterScorePair::ParameterScorePair	(	QMCObjectiveFunctionResult	score,
		Array1D< double > &	parameters
	)

Creates an uninitialized instance of this class and sets the score and parameter values.

Parameters:

	score	Score.
	parameters	Parameters.

Definition at line 19 of file ParameterScorePair.cpp.

References Parameters, and Score.

ParameterScorePair::ParameterScorePair

(

const ParameterScorePair &

PSP

)

Creates an instance of this class which is equal to another instance.

Definition at line 26 of file ParameterScorePair.cpp.

---

Member Function Documentation

double ParameterScorePair::getScore

(

)

const

Gets the score.

Returns:

score.

Definition at line 63 of file ParameterScorePair.cpp.

References QMCObjectiveFunctionResult::getScore(), and Score.

Referenced by operator<(), and operator<<().

Array1D< double > * ParameterScorePair::getParameters

(

)

Gets the parameters.

Returns:

paramters.

Definition at line 69 of file ParameterScorePair.cpp.

References Parameters.

Referenced by CKGeneticAlgorithm1::generateNewPopulation(), and CKGeneticAlgorithm1::optimize().

void ParameterScorePair::operator=

(

const ParameterScorePair &

rhs

)

Set two ParameterScorePair objects equal.

Parameters:

rhs

object to set this object equal to.

Definition at line 31 of file ParameterScorePair.cpp.

References Parameters, and Score.

bool ParameterScorePair::operator<

(

const ParameterScorePair &

PSP

)

const

An operator which orders ParameterScorePair objects based on their scores.

Definition at line 37 of file ParameterScorePair.cpp.

References getScore().

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	strm,
		const ParameterScorePair &	rhs
	)			[friend]

Prints the contents of this object in a human readable format.

Definition at line 52 of file ParameterScorePair.cpp.

---

Member Data Documentation

QMCObjectiveFunctionResult ParameterScorePair::Score [private]

Definition at line 80 of file ParameterScorePair.h.

Referenced by getScore(), operator<<(), operator=(), and ParameterScorePair().

Array1D<double> ParameterScorePair::Parameters [private]

Definition at line 81 of file ParameterScorePair.h.

Referenced by getParameters(), operator<<(), operator=(), and ParameterScorePair().

---

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

• ParameterScorePair.h
• ParameterScorePair.cpp