Package ai.libs.jaicore.ml.dyadranking.dataset

Class SparseDyadRankingInstance

java.lang.Object

ai.libs.jaicore.ml.dyadranking.dataset.ADyadRankingInstance

ai.libs.jaicore.ml.dyadranking.dataset.SparseDyadRankingInstance

All Implemented Interfaces:

IAttributeArrayInstance, ILabeledInstance<IDyadRankingInstance>, INumericArrayInstance, IDyadRankingInstance, java.lang.Iterable<Dyad>, org.apache.commons.math3.ml.clustering.Clusterable

public class SparseDyadRankingInstance
extends ADyadRankingInstance
implements INumericArrayInstance

A dyad ranking instance implementation that assumes the same instance for all dyads contained in its ordering. It saves the instance and alternatives separately and contstructs dyads from them on request.

Constructor Summary

Constructors

Constructor	Description
SparseDyadRankingInstance(ai.libs.jaicore.math.linearalgebra.Vector instance, java.util.List<ai.libs.jaicore.math.linearalgebra.Vector> alternatives)	Construct a new sparse dyad ranking instance containing the given instance vector and ordering of alternatives.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
IAttributeValue<?>[]	getAllAttributeValues()
double[]	getAsDoubleVector()	Turns the instance into a double vector.
IAttributeValue<java.lang.Double>	getAttributeValue(int position)
<T> IAttributeValue<T>	getAttributeValueAtPosition(int position, java.lang.Class<T> type)	Getter for the value of an attribute for the given position.
Dyad	getDyadAtPosition(int position)	Get the dyad at the specified position in the ordering contained in this instance.
int	getNumberOfAttributes()	Getter for the number of attributes for the instance.
SparseDyadRankingInstance	getTargetValue()	Getter for the value of the target attribute.
int	hashCode()
java.util.Iterator<Dyad>	iterator()
int	length()	Get the number of dyads in the ranking.
java.lang.String	toString()

Methods inherited from class ai.libs.jaicore.ml.dyadranking.dataset.ADyadRankingInstance

toMatrix

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.libs.jaicore.ml.core.dataset.INumericArrayInstance

getPoint

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SparseDyadRankingInstance

public SparseDyadRankingInstance(ai.libs.jaicore.math.linearalgebra.Vector instance,
                                 java.util.List<ai.libs.jaicore.math.linearalgebra.Vector> alternatives)

Construct a new sparse dyad ranking instance containing the given instance vector and ordering of alternatives.

Parameters:

instance - the instance for all of the alternatives

alternatives - the ordering of alternatives that, when combined with the instances is an ordering of dyads

Method Detail

getAttributeValueAtPosition

public <T> IAttributeValue<T> getAttributeValueAtPosition(int position,
                                                          java.lang.Class<T> type)

Description copied from interface: IAttributeArrayInstance

Getter for the value of an attribute for the given position.

Specified by:

getAttributeValueAtPosition in interface IAttributeArrayInstance

Parameters:

position - The position of the attribute within the instance.

type - The type for which the attribute value shall be returned.

Returns:

The attribute value for the position.

getTargetValue

public SparseDyadRankingInstance getTargetValue()

Description copied from interface: ILabeledInstance

Getter for the value of the target attribute.

Specified by:

getTargetValue in interface ILabeledInstance<IDyadRankingInstance>

Returns:

The value of the traget attribute.

getAsDoubleVector

public double[] getAsDoubleVector()
                           throws ContainsNonNumericAttributesException

Description copied from interface: INumericArrayInstance

Turns the instance into a double vector.

Specified by:

getAsDoubleVector in interface INumericArrayInstance

Returns:

The instance as a double vector.

Throws:

ContainsNonNumericAttributesException - Thrown if the instance is to be converted into a double vector and still contains non-numeric attributes.

iterator

public java.util.Iterator<Dyad> iterator()

Specified by:

iterator in interface java.lang.Iterable<Dyad>

getDyadAtPosition

public Dyad getDyadAtPosition(int position)

Description copied from interface: IDyadRankingInstance

Get the dyad at the specified position in the ordering contained in this instance.

Specified by:

getDyadAtPosition in interface IDyadRankingInstance

Parameters:

position - The position in the ordering for which to get the dyad

Returns:

The dyad at the specified position

length

public int length()

Description copied from interface: IDyadRankingInstance

Get the number of dyads in the ranking.

Specified by:

length in interface IDyadRankingInstance

Returns:

The number of dyads in the ranking.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAllAttributeValues

public IAttributeValue<?>[] getAllAttributeValues()

Specified by:

getAllAttributeValues in interface IAttributeArrayInstance

getNumberOfAttributes

public int getNumberOfAttributes()

Description copied from interface: IAttributeArrayInstance

Getter for the number of attributes for the instance.

Specified by:

getNumberOfAttributes in interface IAttributeArrayInstance

Returns:

Number of attributes

getAttributeValue

public IAttributeValue<java.lang.Double> getAttributeValue(int position)

Specified by:

getAttributeValue in interface INumericArrayInstance