Class ImmutableRegressionInfo

java.lang.Object

org.tribuo.regression.RegressionInfo

org.tribuo.regression.ImmutableRegressionInfo

All Implemented Interfaces:

Serializable, Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer, Regressor>>, ImmutableOutputInfo<Regressor>, OutputInfo<Regressor>

public class ImmutableRegressionInfo
extends RegressionInfo
implements ImmutableOutputInfo<Regressor>

A ImmutableOutputInfo for Regressors.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.regression.RegressionInfo

countMap, maxMap, meanMap, minMap, overallCount, sumSquaresMap, unknownCount

Method Summary

Modifier and Type	Method	Description
ImmutableRegressionInfo	copy()	Generates a copy of this OutputInfo, including it's mutability.
Set<Regressor>	getDomain()	Returns a set containing a Regressor for each dimension with the minimum value observed.
int	getID(Regressor output)	Return the id number associated with this output, or -1 if the output is unknown.
int[]	getIDtoNaturalOrderMapping()	Computes the mapping between ID numbers and regressor dimension indices.
int[]	getNaturalOrderToIDMapping()	Computes the mapping between regressor dimension indices and ID numbers.
Regressor	getOutput(int id)	Returns the output associated with this id, or null if the id is unknown.
long	getTotalObservations()	Returns the total number of observed outputs seen by this ImmutableOutputInfo.
Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer, Regressor>>	iterator()
String	toReadableString()	Generates a String form of this OutputInfo.
String	toString()
boolean	validateMapping()	Returns true if the id numbers correspond to a lexicographic ordering of the dimension names starting from zero, false otherwise.

Methods inherited from class org.tribuo.regression.RegressionInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getMax, getMean, getMin, getUnknownCount, getVariance, outputCountsIterable, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.tribuo.OutputInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getUnknownCount, outputCountsIterable, size

Method Details

getDomain

public Set<Regressor> getDomain()

Description copied from class: RegressionInfo

Returns a set containing a Regressor for each dimension with the minimum value observed.

Specified by:

getDomain in interface OutputInfo<Regressor>

Overrides:

getDomain in class RegressionInfo

Returns:

A set of Regressors, each with one active dimension.

getID

public int getID(Regressor output)

Description copied from interface: ImmutableOutputInfo

Return the id number associated with this output, or -1 if the output is unknown.

Specified by:

getID in interface ImmutableOutputInfo<Regressor>

Parameters:

output - An output

Returns:

A non-negative integer if the output is known, or -1 if the output is unknown.

getOutput

public Regressor getOutput(int id)

Description copied from interface: ImmutableOutputInfo

Returns the output associated with this id, or null if the id is unknown.

Specified by:

getOutput in interface ImmutableOutputInfo<Regressor>

Parameters:

id - A non-negative integer.

Returns:

An output object or null if it's unknown.

getTotalObservations

public long getTotalObservations()

Description copied from interface: ImmutableOutputInfo

Returns the total number of observed outputs seen by this ImmutableOutputInfo.

Specified by:

getTotalObservations in interface ImmutableOutputInfo<Regressor>

Returns:

The number of observed outputs.

copy

public ImmutableRegressionInfo copy()

Description copied from interface: OutputInfo

Generates a copy of this OutputInfo, including it's mutability.

Specified by:

copy in interface OutputInfo<Regressor>

Specified by:

copy in class RegressionInfo

Returns:

A copy of the OutputInfo.

toString

public String toString()

Overrides:

toString in class Object

validateMapping

public boolean validateMapping()

Returns true if the id numbers correspond to a lexicographic ordering of the dimension names starting from zero, false otherwise.

Returns:

True if the id mapping corresponds to lexicographic ordering of the names.

getIDtoNaturalOrderMapping

public int[] getIDtoNaturalOrderMapping()

Computes the mapping between ID numbers and regressor dimension indices.

In some situations the regressor dimension ID numbers may not use the natural ordering (i.e., the lexicographic order of the dimension names). This method computes the mapping from the id numbers to the natural ordering.

Returns:

An array where arr[id] = natural_idx.

getNaturalOrderToIDMapping

public int[] getNaturalOrderToIDMapping()

Computes the mapping between regressor dimension indices and ID numbers.

In some situations the regressor dimension ID numbers may not use the natural ordering (i.e., the lexicographic order of the dimension names). This method computes the mapping from the natural ordering to the id numbers.

Returns:

An array where arr[natural_idx] = id.

toReadableString

public String toReadableString()

Description copied from interface: OutputInfo

Generates a String form of this OutputInfo.

This String can contain newlines, tabs and other formatting.

Specified by:

toReadableString in interface OutputInfo<Regressor>

Returns:

A formatted String representing this OutputInfo.

iterator

public Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer, Regressor>> iterator()

Specified by:

iterator in interface Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer, Regressor>>