Package org.optaplanner.core.impl.heuristic.selector.list

Class TriangularNumbers

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.list.TriangularNumbers

public final class TriangularNumbers
extends Object

Method Summary

Modifier and Type	Method	Description
static int	nthTriangle(int n)	Calculate nth triangular number.

Methods inherited from class java.lang.Object

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

Method Details

nthTriangle

public static int nthTriangle(int n)
                       throws ArithmeticException

Calculate nth triangular number. This is used to calculate the number of subLists for a given list variable of size n. To be able to use int arithmetic to calculate the triangular number, n must be less than or equal to HIGHEST_SAFE_N. If the n is higher, the method throws an exception.

Parameters:

n - size of the triangle (the length of its side)

Returns:

nth triangular number

Throws:

ArithmeticException - if n is higher than HIGHEST_SAFE_N