hep.dataforge.datafitter

Class ParamSet

java.lang.Object

hep.dataforge.datafitter.ParamSet

All Implemented Interfaces:

NamedDoubleSet, NamedSet

public class ParamSet
extends java.lang.Object
implements NamedDoubleSet

Реализация набора параметров, которая будет потом использоваться в Result, Fitter и Spectrum Подразумевается, что ParamSet обязательно содержит помимо значения хотя бы ошибку.

Constructor Summary

Constructors

Constructor and Description
ParamSet() Constructor for ParamSet.
ParamSet(NamedDoubleSet values) Constructor for ParamSet.
ParamSet(ParamSet other) Constructor for ParamSet.
ParamSet(java.lang.String[] names) Generates set of parameters with predefined names.

Method Summary

Modifier and Type	Method and Description
ParamSet	copy() copy.
static ParamSet	fromAnnotation(Meta cfg) fromAnnotation.
static ParamSet	fromString(java.lang.String str) Read parameter set from lines using 'name' = value ± error (lower,upper) syntax
static ParamSet	fromXML(java.lang.String xml) fromXML.
Param	getByName(java.lang.String str) Returns link to parameter with specific name.
int	getDimension()
double	getError(java.lang.String str) getError.
java.util.Collection<Param>	getParams() Getter for the field params.
NamedDoubleArray	getParErrors(java.lang.String... names) getParErrors.
NamedDoubleArray	getParValues(java.lang.String... names) getParValues.
ParamSet	getSubSet(java.lang.String... names) Returns a parameter set witch consists only of names presented as parameter (values are also copied).
double	getValue(java.lang.String str) getValue.
double[]	getValues(java.lang.String... names) getValues.
Names	names()
ParamSet	setPar(Param input) Searches set for a parameter with the same name and replaces it.
ParamSet	setPar(java.lang.String name, double value, double error) setPar.
ParamSet	setPar(java.lang.String name, double value, double error, java.lang.Double lower, java.lang.Double upper) setPar.
ParamSet	setParDomain(java.lang.String name, java.lang.Double lower, java.lang.Double upper) setParDomain.
ParamSet	setParError(java.lang.String name, double value) setParError.
ParamSet	setParErrors(NamedDoubleSet errors) method to set all parameter errors.
ParamSet	setParValue(java.lang.String name, double value) setParValue.
ParamSet	setParValues(NamedDoubleSet values) method to set all parameter values.
void	updateFrom(ParamSet set) updateFrom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hep.dataforge.maths.NamedDoubleSet

toString

Methods inherited from interface hep.dataforge.names.NamedSet

namesAsArray

Constructor Detail

ParamSet

public ParamSet(java.lang.String[] names)
         throws NameNotFoundException

Generates set of parameters with predefined names.

Parameters:

names - an array of String objects.

Throws:

NameNotFoundException - if any.

ParamSet

public ParamSet(ParamSet other)

Constructor for ParamSet.

Parameters:

other - a ParamSet object.

ParamSet

public ParamSet()

Constructor for ParamSet.

ParamSet

public ParamSet(NamedDoubleSet values)

Constructor for ParamSet.

Parameters:

values - a NamedDoubleSet object.

Method Detail

fromAnnotation

@Element(name="param",multiple=true,description="The fit prameter",target="method::hep.dataforge.datafitter.Param.fromAnnotation") @Element(name="params",description="Could be used as a wrapper for \'param\' elements. Used solely on purpose of xml readability.")
public static ParamSet fromAnnotation(Meta cfg)

fromAnnotation.

Parameters:

cfg - a Meta object.

Returns:

a ParamSet object.

fromXML

public static ParamSet fromXML(java.lang.String xml)
                        throws java.text.ParseException

fromXML.

Parameters:

xml - a String object.

Returns:

a ParamSet object.

Throws:

java.text.ParseException - if any.

fromString

public static ParamSet fromString(java.lang.String str)

Read parameter set from lines using 'name' = value ± error (lower,upper) syntax

Parameters:

str - a String object.

Returns:

a ParamSet object.

copy

public ParamSet copy()

copy.

Returns:

a ParamSet object.

getByName

public Param getByName(java.lang.String str)
                throws NameNotFoundException

Returns link to parameter with specific name. Возвращает параметр по его имени.

Parameters:

str - a String object.

Returns:

null if name is not found.

Throws:

NameNotFoundException - if any.

getDimension

public int getDimension()

Specified by:

getDimension in interface NamedSet

getError

public double getError(java.lang.String str)
                throws NameNotFoundException

getError.

Parameters:

str - a String object.

Returns:

a double.

Throws:

NameNotFoundException - if any.

names

public Names names()

Specified by:

names in interface NamedSet

Returns:

getParErrors

public NamedDoubleArray getParErrors(java.lang.String... names)
                              throws NameNotFoundException

getParErrors.

Parameters:

names - a String object.

Returns:

a NamedDoubleArray object.

Throws:

NameNotFoundException - if any.

getParValues

public NamedDoubleArray getParValues(java.lang.String... names)
                              throws NameNotFoundException

getParValues.

Parameters:

names - a String object.

Returns:

a NamedDoubleArray object.

Throws:

NameNotFoundException - if any.

getParams

public java.util.Collection<Param> getParams()

Getter for the field params.

Returns:

a Collection object.

getSubSet

public ParamSet getSubSet(java.lang.String... names)
                   throws NameNotFoundException

Returns a parameter set witch consists only of names presented as parameter (values are also copied).

Parameters:

names - a String object.

Returns:

a ParamSet object.

Throws:

NameNotFoundException - if any.

getValue

public double getValue(java.lang.String str)
                throws NameNotFoundException

getValue.

Метод возвращает значение параметра с именем str

Specified by:

getValue in interface NamedDoubleSet

Parameters:

str -

Returns:

a double.

Throws:

NameNotFoundException

getValues

public double[] getValues(java.lang.String... names)

getValues.

Specified by:

getValues in interface NamedDoubleSet

Parameters:

names - a String object.

Returns:

an array of double.

setPar

public ParamSet setPar(Param input)

Searches set for a parameter with the same name and replaces it. Only link is replaced, use copy to make a deep copy. In case name not found adds a new parameter

Parameters:

input - a Param object.

Returns:

a ParamSet object.

setPar

public ParamSet setPar(java.lang.String name,
                       double value,
                       double error)

setPar.

Parameters:

name - a String object.

value - a double.

error - a double.

Returns:

a ParamSet object.

setPar

public ParamSet setPar(java.lang.String name,
                       double value,
                       double error,
                       java.lang.Double lower,
                       java.lang.Double upper)

setPar.

Parameters:

name - a String object.

value - a double.

error - a double.

lower - a Double object.

upper - a Double object.

Returns:

a ParamSet object.

setParDomain

public ParamSet setParDomain(java.lang.String name,
                             java.lang.Double lower,
                             java.lang.Double upper)
                      throws NameNotFoundException

setParDomain.

Parameters:

name - a String object.

lower - a Double object.

upper - a Double object.

Returns:

a ParamSet object.

Throws:

NameNotFoundException - if any.

setParError

public ParamSet setParError(java.lang.String name,
                            double value)
                     throws NameNotFoundException

setParError.

Parameters:

name - a String object.

value - a double.

Returns:

a ParamSet object.

Throws:

NameNotFoundException - if any.

setParErrors

public ParamSet setParErrors(NamedDoubleSet errors)
                      throws NameNotFoundException

method to set all parameter errors.

Parameters:

errors - a NamedDoubleSet object.

Returns:

a ParamSet object.

Throws:

NameNotFoundException - if any.

setParValue

public ParamSet setParValue(java.lang.String name,
                            double value)

setParValue.

Parameters:

name - parameter name.

value - a double.

Returns:

a ParamSet object.

setParValues

public ParamSet setParValues(NamedDoubleSet values)
                      throws NameNotFoundException

method to set all parameter values.

Parameters:

values - a NamedDoubleSet object.

Returns:

a ParamSet object.

Throws:

NameNotFoundException - if any.

updateFrom

public void updateFrom(ParamSet set)

updateFrom.

Parameters:

set - a ParamSet object.