Commit 4f0831dd authored by Michael Reuter's avatar Michael Reuter
Browse files

Fixing doxygen errors. This refs #100.

parent a119c281
......@@ -64,6 +64,7 @@ void CompositeFunction::init()
* // write NewFunction's own ties and constraints
* // ostr << ";constraints=(" << ... <<")";
* }
* @return the string representation of the composite function
*/
std::string CompositeFunction::asString()const
{
......@@ -196,6 +197,7 @@ void CompositeFunction::setParameter(int i, const double& value, bool explicitly
/** Get the i-th parameter.
* @param i The parameter index
* @return value of the requested parameter
*/
double CompositeFunction::getParameter(int i)const
{
......@@ -225,6 +227,7 @@ void CompositeFunction::setParameter(const std::string& name, const double& valu
/**
* Parameters by name.
* @param name The name of the parameter.
* @return value of the requested named parameter
*/
double CompositeFunction::getParameter(const std::string& name)const
{
......@@ -248,6 +251,7 @@ int CompositeFunction::nParams()const
/**
*
* @param name The name of a parameter
* @return index of the requested named parameter
*/
int CompositeFunction::parameterIndex(const std::string& name)const
{
......@@ -318,8 +322,9 @@ std::string CompositeFunction::nameOfActive(int i)const
}
/**
* Returns true if parameter i is active
* query to see in the function is active
* @param i The index of a declared parameter
* @return true if parameter i is active
*/
bool CompositeFunction::isActive(int i)const
{
......@@ -610,6 +615,7 @@ void CompositeFunction::replaceFunction(int i,IFunction* f)
/**
* @param i The index of the function
* @return function at the requested index
*/
IFunction* CompositeFunction::getFunction(int i)const
{
......@@ -623,6 +629,7 @@ IFunction* CompositeFunction::getFunction(int i)const
/**
* Get the index of the function to which parameter i belongs
* @param i The parameter index
* @return function index of the requested parameter
*/
int CompositeFunction::functionIndex(int i)const
{
......@@ -636,6 +643,7 @@ int CompositeFunction::functionIndex(int i)const
/**
* Get the index of the function to which parameter i belongs
* @param i The active parameter index
* @return active function index of the requested parameter
*/
int CompositeFunction::functionIndexActive(int i)const
{
......@@ -817,8 +825,9 @@ void CompositeFunction::removeConstraint(const std::string& parName)
getFunction(iFun)->removeConstraint(parameterLocalName(iPar));
}
/** Chexcks if a constraint has been explicitly set
/** Checks if a constraint has been explicitly set
* @param i The parameter index
* @return true if the function is explicitly set
*/
bool CompositeFunction::isExplicitlySet(int i)const
{
......
......@@ -68,6 +68,7 @@ void Function::setParameter(int i, const double& value, bool explicitlySet)
/** Get the i-th parameter.
* @param i The parameter index
* @return the value of the requested parameter
*/
double Function::getParameter(int i)const
{
......@@ -102,6 +103,7 @@ void Function::setParameter(const std::string& name, const double& value, bool e
/**
* Parameters by name.
* @param name The name of the parameter.
* @return the value of the named parameter
*/
double Function::getParameter(const std::string& name)const
{
......@@ -121,6 +123,7 @@ double Function::getParameter(const std::string& name)const
/**
* Returns the index of the parameter named name.
* @param name The name of the parameter.
* @return the index of the named parameter
*/
int Function::parameterIndex(const std::string& name)const
{
......@@ -139,6 +142,7 @@ int Function::parameterIndex(const std::string& name)const
/** Returns the name of parameter i
* @param i The index of a parameter
* @return the name of the parameter at the requested index
*/
std::string Function::parameterName(int i)const
{
......@@ -175,6 +179,7 @@ void Function::declareParameter(const std::string& name,double initValue )
/**
* Returns the "global" index of an active parameter.
* @param i The index of an active parameter
* @return the global index of the requested parameter
*/
int Function::indexOfActive(int i)const
{
......@@ -187,6 +192,7 @@ int Function::indexOfActive(int i)const
/**
* Returns the name of an active parameter.
* @param i The index of an active parameter
* @return the name of the active parameter
*/
std::string Function::nameOfActive(int i)const
{
......@@ -194,8 +200,9 @@ std::string Function::nameOfActive(int i)const
}
/**
* Returns true if parameter i is active
* query if the parameter is active
* @param i The index of a declared parameter
* @return true if parameter i is active
*/
bool Function::isActive(int i)const
{
......
......@@ -298,6 +298,7 @@ double IFunction::activeParameter(int i)const
/** Create a new tie. IFunctions can have their own types of ties.
* @param parName The parameter name for this tie
* @return a new parameter tie
*/
ParameterTie* IFunction::createTie(const std::string& parName)
{
......@@ -308,6 +309,7 @@ ParameterTie* IFunction::createTie(const std::string& parName)
* Ties a parameter to other parameters
* @param parName The name of the parameter to tie.
* @param expr A math expression
* @return newly ties parameters
*/
ParameterTie* IFunction::tie(const std::string& parName,const std::string& expr)
{
......@@ -332,7 +334,7 @@ ParameterTie* IFunction::tie(const std::string& parName,const std::string& expr)
/** Removes the tie off a parameter. The parameter becomes active
* This method can be used when constructing and editing the IFunction in a GUI
* @param parName The name of the paramter which ties will be removed.
* @param parName The name of the parameter which ties will be removed.
*/
void IFunction::removeTie(const std::string& parName)
{
......@@ -353,6 +355,7 @@ void IFunction::calJacobianForCovariance(Jacobian* out, const double* xValues, c
/**
* Writes a string that can be used in Fit.IFunction to create a copy of this IFunction
* @return string representation of the function
*/
std::string IFunction::asString()const
{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment