Scalar 1.0.0 API

All Implemented Interfaces:
```
public final class Scalar

                    
```
An integer $s \lt 2^{255}$ which represents an element of the field $\mathbb{Z} / \ell$.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Scalar.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`isCanonical`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`isCanonical()`
`final ByteArray`	`toByteArray()`	Convert this Scalar to its underlying sequence of bytes.
`final Boolean`	`ctEquals(Scalar other)`	Constant-time equality check.
`Boolean`	`equals(Object other)`	Equality check overridden to be constant-time.
`Integer`	`hashCode()`
`String`	`toString()`
`final Scalar`	`reduce()`	Reduce this Scalar modulo $\ell$.
`final Scalar`	`add(Scalar b)`	Compute $a + b \bmod \ell$.
`final Scalar`	`subtract(Scalar b)`	Compute $a - b \bmod \ell$.
`final Scalar`	`multiply(Scalar b)`	Compute $a * b \bmod \ell$.

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

- Constructor Detail
- Method Detail
  - isCanonical
```
 final Boolean isCanonical()
```
  - toByteArray
```
 final ByteArray toByteArray()
```
    Convert this Scalar to its underlying sequence of bytes.
  - ctEquals
```
 final Boolean ctEquals(Scalar other)
```
    Constant-time equality check.
    Compares the encodings of the two Scalars.
  - equals
```
 Boolean equals(Object other)
```
    Equality check overridden to be constant-time.
    Fails fast if the objects are of different types.
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - reduce
```
 final Scalar reduce()
```
    Reduce this Scalar modulo $\ell$.
  - add
```
 final Scalar add(Scalar b)
```
    Compute $a + b \bmod \ell$.
    If $a$ and $b$ are both canonical Scalars, the result is guaranteed to be a canonical Scalar. In all other cases, the result may be outside the range $[0, \ell)$.
    
    Parameters:
    
    b - the Scalar to add to this.
  - subtract
```
 final Scalar subtract(Scalar b)
```
    Compute $a - b \bmod \ell$.
    If $a$ and $b$ are both canonical Scalars, the result is guaranteed to be a canonical Scalar. In all other cases, the result may be outside the range $[0, \ell)$.
    
    Parameters:
    
    b - the Scalar to subtract from this.
  - multiply
```
 final Scalar multiply(Scalar b)
```
    Compute $a * b \bmod \ell$.
    
    Parameters:
    
    b - the Scalar to multiply with this.