org.linqs.psl.reasoner.function

Class GeneralFunction

java.lang.Object

org.linqs.psl.reasoner.function.GeneralFunction

All Implemented Interfaces:

FunctionTerm

public class GeneralFunction
extends Object
implements FunctionTerm

A general function that can handle various cases. The function is some linear combination of terms. All constant values are merged together into a single constant. Note that the design of this function is to reduce the number of allocations at grounding time.

Constructor Summary

Constructors

Constructor and Description
GeneralFunction(boolean nonNegative, boolean squared, int maxSize)

Method Summary

Modifier and Type	Method and Description
void	add(double value) Add a constant to the sum.
void	add(double coefficient, FunctionTerm term) Add a general term to the sum.
double	getCoefficient(int index)
double	getConstant()
FunctionTerm	getTerm(int index)
double	getValue() Returns the term's value
double	getValue(double[] values) Get the value of this sum, but using the values passed in place of non-constants for the term.
double	getValue(GroundAtom replacementAtom, double replacementValue) Get the value of the sum, but replace the value of a single RVA with the given value.
boolean	isConstant() Returns whether the term is constant.
boolean	isLinear() Returns whether the term is linear in its Variables.
boolean	isNonNegative()
boolean	isSquared()
void	setNonNegative(boolean nonNegative)
void	setSquared(boolean squared)
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneralFunction

public GeneralFunction(boolean nonNegative,
                       boolean squared,
                       int maxSize)

Method Detail

getConstant

public double getConstant()

isSquared

public boolean isSquared()

isNonNegative

public boolean isNonNegative()

isLinear

public boolean isLinear()

Description copied from interface: FunctionTerm

Returns whether the term is linear in its Variables. Returns true if the term is a constant.

Specified by:

isLinear in interface FunctionTerm

isConstant

public boolean isConstant()

Description copied from interface: FunctionTerm

Returns whether the term is constant.

Specified by:

isConstant in interface FunctionTerm

setSquared

public void setSquared(boolean squared)

setNonNegative

public void setNonNegative(boolean nonNegative)

add

public void add(double value)

Add a constant to the sum.

add

public void add(double coefficient,
                FunctionTerm term)

Add a general term to the sum.

size

public int size()

getCoefficient

public double getCoefficient(int index)

getTerm

public FunctionTerm getTerm(int index)

getValue

public double getValue()

Description copied from interface: FunctionTerm

Returns the term's value

Specified by:

getValue in interface FunctionTerm

getValue

public double getValue(double[] values)

Get the value of this sum, but using the values passed in place of non-constants for the term. Note that the constants still apply. This is a fragile function that should only be called by the code that constructed this function in the first place, The passed in values must only contains entries for non-constant atoms (all constants get merged). The passed in values may be larger than the number of values actually used.

getValue

public double getValue(GroundAtom replacementAtom,
                       double replacementValue)

Get the value of the sum, but replace the value of a single RVA with the given value. This should only be called by people who really know what they are doing. Note that the value of the RVA is NOT used, it is only used to find the matching function term. The general version of would be to just have a map, However, the common use case is just having one variable change value and this is typically very high traffic making the map (and autoboxing double) overhead noticable.

toString

public String toString()

Overrides:

toString in class Object