Loss (nd4j-api 1.0.0-M2.1 API)

java.lang.Object
- org.nd4j.autodiff.listeners.Loss

```
public class Loss
extends Object
```

Constructor Summary

Constructors
Constructor Description

Loss(@NonNull List<String> lossNames, @lombok.NonNull double[] losses)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Loss`	`add(Loss other)`
`static Loss`	`add(Loss a, Loss b)`
`static Loss`	`average(List<Loss> losses)`
`Loss`	`copy()`
`Loss`	`div(Number other)`
`static Loss`	`div(Loss a, Number b)`
`double`	`getLoss(@NonNull String lossName)`	Get the specified loss by name
`List<String>`	`lossNames()`
`double[]`	`lossValues()`
`Loss`	`minus(Loss other)`
`int`	`numLosses()`
`Loss`	`plus(Loss other)`
`Loss`	`sub(Loss other)`
`static Loss`	`sub(Loss a, Loss b)`
`static Loss`	`sum(List<Loss> losses)`
`double`	`totalLoss()`

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

Constructor Detail

Loss

public Loss(@NonNull
            @NonNull List<String> lossNames,
            @NonNull
            @lombok.NonNull double[] losses)

Parameters:: lossNames - Names of the losses; losses - Values for each loss. Must be same length as lossNames

Method Detail

numLosses
```
public int numLosses()
```
Returns:

Number of loss values (i.e., length of lossNames and losses)

lossNames
```
public List<String> lossNames()
```
Returns:

Names of all of the loss components

lossValues
```
public double[] lossValues()
```
Returns:

Values corresponding to each of the losses (same order as lossNames())

getLoss
```
public double getLoss(@NonNull
                      @NonNull String lossName)
```
Get the specified loss by name

Parameters:

lossName - Name of the loss (must exist)

Returns:

Specified loss value

totalLoss
```
public double totalLoss()
```
Returns:

The total loss (sum of all loss components)

copy
```
public Loss copy()
```

sum

public static Loss sum(List<Loss> losses)

average

public static Loss average(List<Loss> losses)

add

public static Loss add(Loss a,
                       Loss b)

sub

public static Loss sub(Loss a,
                       Loss b)

div

public static Loss div(Loss a,
                       Number b)

add
```
public Loss add(Loss other)
```

sub
```
public Loss sub(Loss other)
```

plus
```
public Loss plus(Loss other)
```

minus
```
public Loss minus(Loss other)
```

div
```
public Loss div(Number other)
```