Class representing a real number. More...

Inheritance diagram for frodo2.solutionSpaces.AddableReal:

[legend]

Classes
class	PlusInfinity
	A singleton class representing the real number +infinity. More...
class	MinInfinity
	A singleton class representing the real number -infinity. More...
class	AddableRealDelayed
	Class used to make the addition of a large number of reals more efficient. More...

Public Member Functions
	AddableReal ()
	Default constructor.
	AddableReal (double value)
	Constructor.
void	writeExternal (ObjectOutput arg0) throws IOException
void	readExternal (ObjectInput arg0) throws IOException, ClassNotFoundException
final boolean	externalize ()
Object	readResolve ()
AddableReal	fromString (final String str)
AddableReal	fromInt (int nbr)
String	toString ()
AddableReal	add (final AddableReal o)
	Adds this real number with another.
AddableReal	multiply (final AddableReal o)
	Multiplies this AddableReal with another AddableReal.
AddableReal	getMinInfinity ()
AddableReal	getPlusInfinity ()
AddableReal	getZero ()
AddableReal	min (final AddableReal o)
	Computes the minimum of two AddableReals.
AddableReal	max (final AddableReal o)
AddableReal	abs ()
int	compareTo (final AddableReal o)
	Compares this real number with another one.
int	compareTo (final AddableReal o, double error)
	Compares this real number with another one with some error margin.
boolean	equals (final Object o)
boolean	equals (final AddableReal that, double error)
	Compares two AddableReals within some error margin.
int	hashCode ()
int	intValue ()
double	doubleValue ()
AddableReal	flipSign ()
AddableReal	log ()
AddableReal	subtract (final AddableReal o)
	Subtracts o from this AddableReal.
AddableReal	divide (final AddableReal o)
Addable< AddableReal >[]	range (AddableReal begin, AddableReal end)
AddableDelayed< AddableReal >	addDelayed ()
Public Member Functions inherited from frodo2.solutionSpaces.Addable< AddableReal >
int	intValue ()
double	doubleValue ()
T	fromString (String str)
	Parses a string to construct a new instance.
T	fromInt (int nbr)
	Creates an instance from an int.
T	add (T o)
	Adds an object to this object.
AddableDelayed< T >	addDelayed ()
	Creates an object with the same value as this object, used to delay the resolution of a large number of additions.
T	subtract (T o)
	Subtracts an object from this object.
T	multiply (T o)
	Multiplies an object with this object.
boolean	equals (Object o)
	The equals function must be implemented so that the hashmap storing the steps for each value can find the proper step for the provided value.
int	hashCode ()
	The hashCode function must be implemented so that the hashmap storing the steps for each value can find the proper step for the provided value.
T	getZero ()
	Returns a neutral object for the addition operation ("zero").
T	getPlusInfinity ()
	Returns the "+infinity" object.
T	getMinInfinity ()
	Returns the "-infinity" object.
T	abs ()
T	divide (T o)
T	flipSign ()
	Flip the sign of this number.
Addable< T >[]	range (T begin, T end)
	Returns an array containing all the values between `begin` and `end`.

Private Attributes
double	value
	The value of this real number.

Static Private Attributes
static final long	serialVersionUID = -2877043522184206202L
	Used for serialization.

Detailed Description

Class representing a real number.

Author: Thomas Leaute

Constructor & Destructor Documentation

◆ AddableReal() [1/2]

frodo2.solutionSpaces.AddableReal.AddableReal ( )

Default constructor.

◆ AddableReal() [2/2]

frodo2.solutionSpaces.AddableReal.AddableReal ( double value )

Constructor.

Parameters

value the value for the real number

References value.

Member Function Documentation

◆ abs()

AddableReal frodo2.solutionSpaces.AddableReal.abs ( )

See also: Addable.abs()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), and value.

Here is the call graph for this function:

◆ add()

AddableReal frodo2.solutionSpaces.AddableReal.add ( final AddableReal o )

Adds this real number with another.

Parameters

o	the other real number

Returns: a new real number equal to the sum of the two

See also: Addable#add(Addable)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Here is the call graph for this function:

◆ addDelayed()

AddableDelayed< AddableReal > frodo2.solutionSpaces.AddableReal.addDelayed ( )

See also: Addable.addDelayed()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References value.

◆ compareTo() [1/2]

int frodo2.solutionSpaces.AddableReal.compareTo ( final AddableReal o )

Compares this real number with another one.

Parameters

o	the other real number

Returns: +1 if this number is greater than o, -1 if it is smaller, and 0 if they are equal

See also: java.lang.Comparable#compareTo(java.lang.Object)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Referenced by frodo2.algorithms.dpop.stochastic.test.ExpectedUTILtest.Listener.checkOutput(), max(), min(), frodo2.algorithms.duct.Sampling< V extends Addable< V > >.VariableInfo.solveLeaf(), frodo2.algorithms.duct.SamplingPruning< V extends Addable< V > >.VariableInfo.solveLeaf(), frodo2.algorithms.duct.tests.NormalizeInfTest.test(), frodo2.algorithms.duct.tests.NormalizeTest.test(), frodo2.solutionSpaces.vehiclerouting.test.VRPtests.testBestFirstiterator(), frodo2.solutionSpaces.vehiclerouting.test.VRPtests.testCompoundBestFirstIterator(), and frodo2.solutionSpaces.hypercube.tests.HypercubeTest.testConsensusWeighted().

Here is the call graph for this function:

◆ compareTo() [2/2]

int frodo2.solutionSpaces.AddableReal.compareTo	(	final AddableReal	o,
		double	error )

Compares this real number with another one with some error margin.

Parameters

o	the other real number
error	the (non-negative) error margin

Returns: +1 if this number is greater than o, -1 if it is smaller, and 0 if they are equal

See also: java.lang.Comparable#compareTo(java.lang.Object)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Here is the call graph for this function:

◆ divide()

AddableReal frodo2.solutionSpaces.AddableReal.divide ( final AddableReal o )

Parameters

o	The real to divide with

Returns: the result of the division

See also: Addable#divide(Addable)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Referenced by frodo2.algorithms.duct.SamplingChild< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingChildSearch< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.SamplingPruningSearch< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.Convergence< V extends Addable< V >, U extends Addable< U > >.processRuns().

Here is the call graph for this function:

◆ doubleValue()

double frodo2.solutionSpaces.AddableReal.doubleValue ( )

See also: Addable.doubleValue()

Referenced by frodo2.algorithms.duct.termination.TerminateBest< V extends Addable< V > >.converged(), frodo2.algorithms.duct.termination.TerminateBest_Child< V extends Addable< V > >.converged(), frodo2.benchmarks.party.PartyGame.encodeProblem(), frodo2.algorithms.duct.samplingMethods.SamplingM< V extends Addable< V > >.processSample(), frodo2.algorithms.duct.samplingMethods.SamplingM_Child< V extends Addable< V > >.processSample(), frodo2.algorithms.duct.SearchNode< V extends Addable< V > >.storeCost(), frodo2.algorithms.duct.SearchNodeChild< V extends Addable< V > >.storeCost(), frodo2.algorithms.duct.SearchNodePruning< V extends Addable< V > >.storeCost(), frodo2.solutionSpaces.hypercube.tests.HypercubeTest.testExpectation(), and frodo2.algorithms.duct.SearchNode< V extends Addable< V > >.toString().

◆ equals() [1/2]

boolean frodo2.solutionSpaces.AddableReal.equals	(	final AddableReal	that,
		double	error )

Compares two AddableReals within some error margin.

Parameters

that	the other AddableReal
error	the (non-negative) error margin

Returns: whether the two AddableReals are equal within the given error margin

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), equals(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Here is the call graph for this function:

◆ equals() [2/2]

boolean frodo2.solutionSpaces.AddableReal.equals ( final Object o )

See also: java.lang.Object#equals(java.lang.Object)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Referenced by frodo2.algorithms.dpop.stochastic.test.E_DPOPagentTest< V extends Addable< V > >.checkOutput(), equals(), frodo2.algorithms.duct.Normalize< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.NormalizeInf< V extends Addable< V > >.notifyIn(), frodo2.algorithms.duct.tests.NormalizeInfTest.test(), frodo2.algorithms.duct.tests.NormalizeTest.test(), frodo2.solutionSpaces.vehiclerouting.test.VRPtests.test(), frodo2.solutionSpaces.hypercube.tests.HypercubeTest.testExpectation(), frodo2.algorithms.test.XCSPparserTest.testGetMinInfUtility(), frodo2.algorithms.test.XCSPparserTest.testGetPlusInfUtility(), and frodo2.algorithms.test.XCSPparserTest.testGetZeroUtility().

Here is the call graph for this function:

◆ externalize()

final boolean frodo2.solutionSpaces.AddableReal.externalize ( )

See also: AddableLimited.externalize()

◆ flipSign()

AddableReal frodo2.solutionSpaces.AddableReal.flipSign ( )

See also: Addable.flipSign()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), and value.

Referenced by frodo2.algorithms.duct.Normalize< V extends Addable< V > >.normalize(), and frodo2.algorithms.duct.NormalizeInf< V extends Addable< V > >.normalize().

Here is the call graph for this function:

◆ fromInt()

AddableReal frodo2.solutionSpaces.AddableReal.fromInt ( int nbr )

See also: Addable.fromInt(int)

References AddableReal().

Here is the call graph for this function:

◆ fromString()

AddableReal frodo2.solutionSpaces.AddableReal.fromString ( final String str )

See also: Addable.fromString(java.lang.String)

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, and frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF.

Referenced by frodo2.algorithms.duct.Normalize< V extends Addable< V > >.Normalize(), and frodo2.algorithms.Convergence< V extends Addable< V >, U extends Addable< U > >.processRuns().

Here is the call graph for this function:

◆ getMinInfinity()

AddableReal frodo2.solutionSpaces.AddableReal.getMinInfinity ( )

See also: Addable.getMinInfinity()

References AddableReal(), and frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF.

Referenced by frodo2.algorithms.Convergence< V extends Addable< V >, U extends Addable< U > >.processRuns(), frodo2.solutionSpaces.vehiclerouting.test.VRPtests.testBestFirstiterator(), and frodo2.solutionSpaces.vehiclerouting.test.VRPtests.testCompoundBestFirstIterator().

Here is the call graph for this function:

◆ getPlusInfinity()

AddableReal frodo2.solutionSpaces.AddableReal.getPlusInfinity ( )

See also: Addable.getPlusInfinity()

References AddableReal(), and frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF.

Referenced by frodo2.algorithms.Convergence< V extends Addable< V >, U extends Addable< U > >.processRuns().

Here is the call graph for this function:

◆ getZero()

AddableReal frodo2.solutionSpaces.AddableReal.getZero ( )

See also: Addable.getZero()

References AddableReal().

Here is the call graph for this function:

◆ hashCode()

int frodo2.solutionSpaces.AddableReal.hashCode ( )

See also: java.lang.Object#hashCode()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

◆ intValue()

int frodo2.solutionSpaces.AddableReal.intValue ( )

See also: Addable.intValue()

◆ log()

AddableReal frodo2.solutionSpaces.AddableReal.log ( )

Returns: the natural logarithm of this number

Reimplemented in frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal().

Here is the call graph for this function:

◆ max()

AddableReal frodo2.solutionSpaces.AddableReal.max ( final AddableReal o )

Parameters

o	The maximum of this value and the input

Returns: the max of this addable real and o

See also: Addable#max(AddableLimited)

References AddableReal(), and compareTo().

Referenced by frodo2.algorithms.duct.Normalize< V extends Addable< V > >.notifyIn().

Here is the call graph for this function:

◆ min()

AddableReal frodo2.solutionSpaces.AddableReal.min ( final AddableReal o )

Computes the minimum of two AddableReals.

Parameters

o	the AddableReal to compare to

Returns: the minimum of the two

See also: Addable#min(AddableLimited)

References AddableReal(), and compareTo().

Here is the call graph for this function:

◆ multiply()

AddableReal frodo2.solutionSpaces.AddableReal.multiply ( final AddableReal o )

Multiplies this AddableReal with another AddableReal.

Parameters

o	the AddableReal to be multiplied with

Returns: a new AddableReal equal to the product

See also: Addable#multiply(Addable)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Referenced by frodo2.algorithms.test.XCSPparserTest.testSetDomain().

Here is the call graph for this function:

◆ range()

Addable< AddableReal >[] frodo2.solutionSpaces.AddableReal.range	(	AddableReal	begin,
		AddableReal	end )

See also: Addable#range(Addable, Addable)

References AddableReal().

Here is the call graph for this function:

◆ readExternal()

void frodo2.solutionSpaces.AddableReal.readExternal ( ObjectInput arg0 ) throws IOException, ClassNotFoundException

See also: java.io.Externalizable#readExternal(java.io.ObjectInput)

Referenced by frodo2.algorithms.duct.BOUNDmsg.readExternal(), frodo2.algorithms.duct.BoundStatsMsg.readExternal(), frodo2.algorithms.duct.COSTBmsg.readExternal(), frodo2.algorithms.duct.COSTmsg.readExternal(), and frodo2.algorithms.duct.NORMmsg.readExternal().

◆ readResolve()

Object frodo2.solutionSpaces.AddableReal.readResolve ( )

See also: AddableLimited.readResolve()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, and frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF.

Referenced by frodo2.algorithms.duct.BOUNDmsg.readExternal(), frodo2.algorithms.duct.BoundStatsMsg.readExternal(), frodo2.algorithms.duct.COSTBmsg.readExternal(), frodo2.algorithms.duct.COSTmsg.readExternal(), and frodo2.algorithms.duct.NORMmsg.readExternal().

◆ subtract()

AddableReal frodo2.solutionSpaces.AddableReal.subtract ( final AddableReal o )

Subtracts o from this AddableReal.

Parameters

o	the value that is subtracted

Returns: the resulting value

See also: Addable#subtract(Addable)

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

References AddableReal(), frodo2.solutionSpaces.AddableReal.MinInfinity.MIN_INF, frodo2.solutionSpaces.AddableReal.PlusInfinity.PLUS_INF, and value.

Referenced by frodo2.algorithms.duct.Normalize< V extends Addable< V > >.notifyIn(), and frodo2.algorithms.duct.NormalizeInf< V extends Addable< V > >.notifyIn().

Here is the call graph for this function:

◆ toString()

String frodo2.solutionSpaces.AddableReal.toString ( )

See also: java.lang.Object#toString()

Reimplemented in frodo2.solutionSpaces.AddableReal.MinInfinity, and frodo2.solutionSpaces.AddableReal.PlusInfinity.

Referenced by frodo2.benchmarks.vehiclerouting.CordeauToXCSP.createXCSP().

◆ writeExternal()

void frodo2.solutionSpaces.AddableReal.writeExternal ( ObjectOutput arg0 ) throws IOException

See also: java.io.Externalizable#writeExternal(java.io.ObjectOutput)

Member Data Documentation

◆ serialVersionUID

final long frodo2.solutionSpaces.AddableReal.serialVersionUID = -2877043522184206202L

staticprivate

Used for serialization.

◆ value

double frodo2.solutionSpaces.AddableReal.value

private

The value of this real number.

Referenced by abs(), add(), AddableReal(), frodo2.solutionSpaces.AddableReal.AddableRealDelayed.addDelayed(), addDelayed(), compareTo(), compareTo(), divide(), equals(), equals(), flipSign(), frodo2.solutionSpaces.AddableReal.MinInfinity.multiply(), multiply(), frodo2.solutionSpaces.AddableReal.PlusInfinity.multiply(), frodo2.solutionSpaces.AddableReal.AddableRealDelayed.multiplyDelayed(), and subtract().

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

src/frodo2/solutionSpaces/AddableReal.java

Classes

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AddableReal() [1/2]

◆ AddableReal() [2/2]

Member Function Documentation

◆ abs()

◆ add()

◆ addDelayed()

◆ compareTo() [1/2]

◆ compareTo() [2/2]

◆ divide()

◆ doubleValue()

◆ equals() [1/2]

◆ equals() [2/2]

◆ externalize()

◆ flipSign()

◆ fromInt()

◆ fromString()

◆ getMinInfinity()

◆ getPlusInfinity()

◆ getZero()

◆ hashCode()

◆ intValue()

◆ log()

◆ max()

◆ min()

◆ multiply()

◆ range()

◆ readExternal()

◆ readResolve()

◆ subtract()

◆ toString()

◆ writeExternal()

Member Data Documentation

◆ serialVersionUID

◆ value