Multipliable9f (decimal4j API 1.0.7-SNAPSHOT)

java.lang.Object
- org.decimal4j.exact.Multipliable9f

```
public final class Multipliable9f
extends Object
```
A Multipliable9f encapsulates a Decimal of scale 9 and facilitates exact typed multiplication. The multipliable object acts as first factor in the multiplication and provides a set of overloaded methods for different scales. Each one of those methods delivers a different result scale which represents the appropriate scale for the product of an exact multiplication.
A Multipliable9f object is returned by Decimal9f.multiplyExact(), hence an exact typed multiplication can be written as:
```
 Decimal9f value = ... //some value
 Decimal11f product = value.multiplyExact().by(Decimal2f.FIVE);
 
```

Constructor Summary

Constructors
Constructor and Description

Multipliable9f(Decimal<Scale9f> value)
Constructor with Decimal value to be encapsulated.

Constructors
Constructor and Description
`Multipliable9f(Decimal<Scale9f> value)` Constructor with Decimal value to be encapsulated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Decimal18f`	`by(Decimal<Scale9f> factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal9f`	`by(Decimal0f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal10f`	`by(Decimal1f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal11f`	`by(Decimal2f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal12f`	`by(Decimal3f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal13f`	`by(Decimal4f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal14f`	`by(Decimal5f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal15f`	`by(Decimal6f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal16f`	`by(Decimal7f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal17f`	`by(Decimal8f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal9f`	`by(MutableDecimal0f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal10f`	`by(MutableDecimal1f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal11f`	`by(MutableDecimal2f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal12f`	`by(MutableDecimal3f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal13f`	`by(MutableDecimal4f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal14f`	`by(MutableDecimal5f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal15f`	`by(MutableDecimal6f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal16f`	`by(MutableDecimal7f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal17f`	`by(MutableDecimal8f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`boolean`	`equals(Object obj)` Compares this Multipliable9f to the specified object.
`Decimal<Scale9f>`	`getValue()` Returns the value underlying this Multipliable9f.
`int`	`hashCode()` Returns a hash code for this `Multipliable9f` which happens to be the hash code of the underlying `Decimal9f` value.
`Decimal18f`	`square()` Returns a `Decimal` whose value is `(this²)`.
`String`	`toString()` Returns a string representation of this `Multipliable9f` which is simply the string representation of the underlying Decimal `value`.

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

- Constructor Detail
  - Multipliable9f
```
public Multipliable9f(Decimal<Scale9f> value)
```
    Constructor with Decimal value to be encapsulated.
    
    Parameters:
    
    value - the decimal value to be wrapped as a multipliable object
- Method Detail
  - getValue
```
public Decimal<Scale9f> getValue()
```
    Returns the value underlying this Multipliable9f.
    
    Returns:
    
    the Decimal value wrapped by this multipliable object
  - square
```
public Decimal18f square()
```
    Returns a Decimal whose value is (this²). The result is exact and has scale 18 which is twice the scale of the Decimal that this multipliable object represents. An ArithmeticException is thrown if the product is out of the possible range for a Decimal18f.
    Note that the result is always a new instance.
    
    Returns:
    
    (this * this)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal18f
  - by
```
public Decimal18f by(Decimal<Scale9f> factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 18 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal18f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal18f
  - by
```
public Decimal9f by(Decimal0f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 9 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal9f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal9f
  - by
```
public Decimal9f by(MutableDecimal0f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 9 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal9f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal9f
  - by
```
public Decimal10f by(Decimal1f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 10 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal10f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal10f
  - by
```
public Decimal10f by(MutableDecimal1f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 10 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal10f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal10f
  - by
```
public Decimal11f by(Decimal2f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 11 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal11f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal11f
  - by
```
public Decimal11f by(MutableDecimal2f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 11 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal11f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal11f
  - by
```
public Decimal12f by(Decimal3f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 12 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal12f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal12f
  - by
```
public Decimal12f by(MutableDecimal3f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 12 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal12f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal12f
  - by
```
public Decimal13f by(Decimal4f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 13 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal13f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal13f
  - by
```
public Decimal13f by(MutableDecimal4f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 13 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal13f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal13f
  - by
```
public Decimal14f by(Decimal5f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 14 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal14f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal14f
  - by
```
public Decimal14f by(MutableDecimal5f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 14 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal14f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal14f
  - by
```
public Decimal15f by(Decimal6f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 15 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal15f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal15f
  - by
```
public Decimal15f by(MutableDecimal6f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 15 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal15f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal15f
  - by
```
public Decimal16f by(Decimal7f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 16 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal16f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal16f
  - by
```
public Decimal16f by(MutableDecimal7f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 16 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal16f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal16f
  - by
```
public Decimal17f by(Decimal8f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 17 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal17f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal17f
  - by
```
public Decimal17f by(MutableDecimal8f factor)
```
    Returns a Decimal whose value is (this * factor). The result is exact and has scale 17 which is the sum of the scales of the Decimal that this multipliable object represents and the scale of the factor argument. An ArithmeticException is thrown if the product is out of the possible range for a Decimal17f.
    Note that the result is always a new instance.
    
    Parameters:
    
    factor - the factor to multiply with the Decimal that this multipliable represents
    
    Returns:
    
    (this * factor)
    
    Throws:
    
    ArithmeticException - if an overflow occurs and product is out of the possible range for a Decimal17f
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Multipliable9f which happens to be the hash code of the underlying Decimal9f value.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object
    
    See Also:
    
    Decimal.hashCode()
  - equals
```
public boolean equals(Object obj)
```
    Compares this Multipliable9f to the specified object. The result is true if and only if the argument is a Multipliable9f with an equal underlying value.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare with
    
    Returns:
    
    true if the argument is a Multipliable9f and if its value is equal to this multipliables's value; false otherwise
    
    See Also:
    
    getValue(), Decimal.equals(Object)
  - toString
```
public String toString()
```
    Returns a string representation of this Multipliable9f which is simply the string representation of the underlying Decimal value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String Decimal representation of this Multipliable9f's value with all the fraction digits (including trailing zeros)
    
    See Also:
    
    getValue(), Decimal.toString()

Class Multipliable9f

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Multipliable9f

Method Detail

getValue

square

by

by

by

by

by

by

by

by

by

by

by

by

by

by

by

by

by

by

by

hashCode

equals

toString