burlap.behavior.singleagent.vfa

Interface ParametricFunction

All Known Subinterfaces:

DifferentiableRF, DifferentiableStateActionValue, DifferentiableStateValue, DifferentiableVInit, ParametricFunction.ParametricStateActionFunction, ParametricFunction.ParametricStateFunction

All Known Implementing Classes:

DiffVFRF, LinearDiffRFVInit, LinearFVVFA, LinearStateActionDifferentiableRF, LinearStateDifferentiableRF, LinearStateDiffVF, LinearVFA, VanillaDiffVinit

public interface ParametricFunction

An interface for defining a parametric function. This interface is often used for value function approximation implementations. This highest-level of the interface does not define the input domain, which is left to subclasses of this interface. For example, the ParametricFunction.ParametricStateFunction operates on State inputs and the ParametricFunction.ParametricStateActionFunction operates on State-AbstractGroundedAction inputs.

Author:

James MacGlashan.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParametricFunction.ParametricStateActionFunction A parametric function that operations on state-actions
static interface	ParametricFunction.ParametricStateFunction A Parametric function that operates on states.

Method Summary

Methods

Modifier and Type	Method and Description
ParametricFunction	copy() Returns a copy of this ParametricFunction.
double	getParameter(int i) Returns the value of the ith parameter value
int	numParameters() Returns the number of parameters defining this function.
void	resetParameters() Resets the parameters of this function to default values.
void	setParameter(int i, double p) Sets the value of the ith parameter to given value

Method Detail

numParameters

int numParameters()

Returns the number of parameters defining this function. Note that some implementations my have a dynamic number of parameters that grows or shrinks over time. Consult the documentation for the specific implementation for more information.

Returns:

the number of parameters defining this function.

getParameter

double getParameter(int i)

Returns the value of the ith parameter value

Parameters:

i - the parameter index

Returns:

the double value of the ith parameter

setParameter

void setParameter(int i,
                double p)

Sets the value of the ith parameter to given value

Parameters:

i - the index of the parameter to set

p - the parameter value to which it should be set

resetParameters

void resetParameters()

Resets the parameters of this function to default values.

copy

ParametricFunction copy()

Returns a copy of this ParametricFunction.

Returns:

a copy of this ParametricFunction.