IDyadRankingInstance (jaicore-ml 0.1.6 API)

All Superinterfaces:

ILabeledInstance<IDyadRankingInstance>, java.lang.Iterable<Dyad>

All Known Implementing Classes:

ADyadRankingInstance, DyadRankingInstance, SparseDyadRankingInstance
```
public interface IDyadRankingInstance
extends ILabeledInstance<IDyadRankingInstance>, java.lang.Iterable<Dyad>
```
Represents an instance for a DyadRankingDataset. A dyad ranking instance contains an ordering of dyads.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Dyad`	`getDyadAtPosition(int position)`	Get the dyad at the specified position in the ordering contained in this instance.
`int`	`length()`	Get the number of dyads in the ranking.
`org.nd4j.linalg.api.ndarray.INDArray`	`toMatrix()`	Converts a dyad ranking to a `INDArray` matrix where each row corresponds to a dyad.

Methods inherited from interface ai.libs.jaicore.ml.core.dataset.ILabeledInstance
getTargetValue

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getDyadAtPosition
```
Dyad getDyadAtPosition(int position)
```
    Get the dyad at the specified position in the ordering contained in this instance.
    
    Parameters:
    
    position - The position in the ordering for which to get the dyad
    
    Returns:
    
    The dyad at the specified position
  - length
```
int length()
```
    Get the number of dyads in the ranking.
    
    Returns:
    
    The number of dyads in the ranking.
  - toMatrix
```
org.nd4j.linalg.api.ndarray.INDArray toMatrix()
```
    Converts a dyad ranking to a INDArray matrix where each row corresponds to a dyad.
    
    Returns:
    
    The dyad ranking in INDArray matrix form.