NDCGLoss (jaicore-ml 0.1.6 API)

java.lang.Object
- ai.libs.jaicore.ml.dyadranking.loss.NDCGLoss

All Implemented Interfaces:

DyadRankingLossFunction
```
public class NDCGLoss
extends java.lang.Object
implements DyadRankingLossFunction
```
The Normalized Discounted Cumulative Gain for ranking.

Constructor Summary

Constructors
Constructor Description

NDCGLoss(int l)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getL()`
`double`	`loss(IDyadRankingInstance actual, IDyadRankingInstance predicted)`	Computes the loss between the actual dyad ordering and predicted dyad ordering, represented by dyad ranking instances.
`void`	`setL(int l)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NDCGLoss
```
public NDCGLoss(int l)
```
    Parameters:
    
    l - The position up to which to compute the cumulative gain (zero-indexed, exclusive).
- Method Detail
  - loss
```
public double loss(IDyadRankingInstance actual,
                   IDyadRankingInstance predicted)
```
    Description copied from interface: DyadRankingLossFunction
    
    Computes the loss between the actual dyad ordering and predicted dyad ordering, represented by dyad ranking instances.
    
    Specified by:
    
    loss in interface DyadRankingLossFunction
    
    Parameters:
    
    actual - the correct ordering
    
    predicted - the predicted ordering
    
    Returns:
    
    the loss between the predicted and correct ordering, depending on the implementation
  - getL
```
public int getL()
```
  - setL
```
public void setL(int l)
```