Multipliable12f (decimal4j API 1.0.7-SNAPSHOT)

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

```
public final class Multipliable12f
extends Object
```
A Multipliable12f encapsulates a Decimal of scale 12 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 Multipliable12f object is returned by Decimal12f.multiplyExact(), hence an exact typed multiplication can be written as:
```
 Decimal12f value = ... //some value
 Decimal14f product = value.multiplyExact().by(Decimal2f.FIVE);
 
```

Constructor Summary

Constructors
Constructor and Description

Multipliable12f(Decimal<Scale12f> value)
Constructor with Decimal value to be encapsulated.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Decimal12f`	`by(Decimal0f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal13f`	`by(Decimal1f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal14f`	`by(Decimal2f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal15f`	`by(Decimal3f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal16f`	`by(Decimal4f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal17f`	`by(Decimal5f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal18f`	`by(Decimal6f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal12f`	`by(MutableDecimal0f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal13f`	`by(MutableDecimal1f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal14f`	`by(MutableDecimal2f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal15f`	`by(MutableDecimal3f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal16f`	`by(MutableDecimal4f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal17f`	`by(MutableDecimal5f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`Decimal18f`	`by(MutableDecimal6f factor)` Returns a `Decimal` whose value is `(this * factor)`.
`boolean`	`equals(Object obj)` Compares this Multipliable12f to the specified object.
`Decimal<Scale12f>`	`getValue()` Returns the value underlying this Multipliable12f.
`int`	`hashCode()` Returns a hash code for this `Multipliable12f` which happens to be the hash code of the underlying `Decimal12f` value.
`String`	`toString()` Returns a string representation of this `Multipliable12f` 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
  - Multipliable12f
```
public Multipliable12f(Decimal<Scale12f> 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<Scale12f> getValue()
```
    Returns the value underlying this Multipliable12f.
    
    Returns:
    
    the Decimal value wrapped by this multipliable object
  - by
```
public Decimal12f by(Decimal0f 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(MutableDecimal0f 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(Decimal1f 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(MutableDecimal1f 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(Decimal2f 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(MutableDecimal2f 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(Decimal3f 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(MutableDecimal3f 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(Decimal4f 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(MutableDecimal4f 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(Decimal5f 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(MutableDecimal5f 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 Decimal18f by(Decimal6f 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 Decimal18f by(MutableDecimal6f 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
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Multipliable12f which happens to be the hash code of the underlying Decimal12f 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 Multipliable12f to the specified object. The result is true if and only if the argument is a Multipliable12f with an equal underlying value.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare with
    
    Returns:
    
    true if the argument is a Multipliable12f 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 Multipliable12f which is simply the string representation of the underlying Decimal value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String Decimal representation of this Multipliable12f's value with all the fraction digits (including trailing zeros)
    
    See Also:
    
    getValue(), Decimal.toString()

Class Multipliable12f

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Multipliable12f

Method Detail

getValue

by

by

by

by

by

by

by

by

by

by

by

by

by

by

hashCode

equals

toString