java.lang.Object
- xyz.cofe.num.BaseNumbers

All Implemented Interfaces:: Numbers<Number>

public class BaseNumbers
extends Object
implements Numbers<Number>

Author:: Kamnev Georgiy

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BaseNumbers.BaseNumbersBuilder
Выбор общего основаия

Field Summary

Fields
Modifier and Type	Field	Description
`protected BitCount`	`minBitsCount`	Минимальное кол-во бит на значение числа
`protected Number`	`one`	Число обозначающее единицу
`protected Number`	`zero`	Число обозначающее ноль

Constructor Summary

Constructors
Constructor	Description
`BaseNumbers()`	Конструктор по умолчанию: minBitsCount = BitCount.INT zero = 0 one = 1
`BaseNumbers(BitCount minBitsCount, Number zero, Number one)`	Конструктор

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Number`	`add(Number a, Number b)`	Сложение чисел
`static BaseNumbers.BaseNumbersBuilder`	`base()`	Выбор общего основания
`static int`	`bitCount(Number n)`	Возвращает кол-во бит испольуемых для представления числа
`static Number`	`cast(Number num, Class<? extends Number> base)`	Преобразует число к указанному типу
`static CommonBase`	`commonBase(Number n0, Number n1)`	Возвращает интерфейс для работы с общим основанием чисел.
`static CommonBase`	`commonBase(Number n0, Number n1, BitCount minBitsCount)`	Возвращает интерфейс для работы с общим основанием чисел.
`Number`	`div(Number a, Number b)`	Деление чисел
`boolean`	`equals(Number a, Number b)`	Сравнивает два числа на равность
`boolean`	`infinity(Number n)`	Проверяет что число является бесконечностью
`static boolean`	`integerNumber(Number n)`	Проверяет что указанное число является целым / натуральным (byte,short,int,long,BigInteger,AtomicInteger,AtomicLong)
`boolean`	`less(Number a, Number b)`	Сравннвает числа
`boolean`	`more(Number a, Number b)`	Сравннвает числа
`Number`	`mul(Number a, Number b)`	Умножение чисел
`Number`	`next(Number n)`	Возвращает следующее число
`Number`	`one()`	Возвращает единицу
`Number`	`prev(Number n)`	Возвращает предыдущее число
`static boolean`	`ratioNumber(Number n)`	Проверяет что указанное число является дробным / рациональным (float,double,BigDecimal)
`Number`	`remainder(Number a, Number b)`	Остаток от деления
`static SingleBase`	`singleBase(Number n0, BitCount minBitsCount)`	Возвращает интерфейс для операции над числами
`Number`	`sub(Number a, Number b)`	Вычитание чисел
`boolean`	`undefined(Number n)`	Проверяет что число не определенно
`static boolean`	`unlimited(Number n)`	Проверяет что указанное число относиться к большим числам (BigInteger, BigDecimal)
`Number`	`zero()`	Возвращает нулевое число
`boolean`	`zero(Number n)`	Проверяет что число является нулем

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

- Field Detail
  - minBitsCount
```
protected final BitCount minBitsCount
```
    Минимальное кол-во бит на значение числа
  - zero
```
protected final Number zero
```
    Число обозначающее ноль
  - one
```
protected final Number one
```
    Число обозначающее единицу
- Constructor Detail
  - BaseNumbers
```
public BaseNumbers()
```
    Конструктор по умолчанию:
    minBitsCount = BitCount.INT
    zero = 0
    one = 1
  - BaseNumbers
```
public BaseNumbers(BitCount minBitsCount,
                   Number zero,
                   Number one)
```
    Конструктор
    
    Parameters:
    
    minBitsCount - минимальное кол-во бит
    
    zero - число ноль
    
    one - число единица
- Method Detail
  - integerNumber
```
public static boolean integerNumber(Number n)
```
    Проверяет что указанное число является целым / натуральным (byte,short,int,long,BigInteger,AtomicInteger,AtomicLong)
    
    Parameters:
    
    n - чило
    
    Returns:
    
    true - является целым числом
  - ratioNumber
```
public static boolean ratioNumber(Number n)
```
    Проверяет что указанное число является дробным / рациональным (float,double,BigDecimal)
    
    Parameters:
    
    n - число
    
    Returns:
    
    true - является дробным
  - bitCount
```
public static int bitCount(Number n)
```
    Возвращает кол-во бит испольуемых для представления числа
    
    Parameters:
    
    n - Число
    
    Returns:
    
    Кол-во бит, 0 - для null, -1 для неизвестного типа
  - unlimited
```
public static boolean unlimited(Number n)
```
    Проверяет что указанное число относиться к большим числам (BigInteger, BigDecimal)
    
    Parameters:
    
    n - Число
    
    Returns:
    
    true - является большим
  - cast
```
public static Number cast(Number num,
                          Class<? extends Number> base)
```
    Преобразует число к указанному типу
    
    Parameters:
    
    num - Число
    
    base - Тип
    
    Returns:
    
    Число указанного типа
  - singleBase
```
public static SingleBase singleBase(Number n0,
                                    BitCount minBitsCount)
```
    Возвращает интерфейс для операции над числами
    
    Parameters:
    
    n0 - Число
    
    minBitsCount - минимальное кол-во бит
    
    Returns:
    
    Интерфейс для мат операций
  - commonBase
```
public static CommonBase commonBase(Number n0,
                                    Number n1)
```
    Возвращает интерфейс для работы с общим основанием чисел. Основание (тип чисел) береться такое чтоб не потерять точность вычислений.
    см commonBase(Number, Number, BitCount)
    
    Parameters:
    
    n0 - Число А
    
    n1 - Число Б
    
    Returns:
    
    Возвращает интерфейс с минимальной потерей точности
  - commonBase
```
public static CommonBase commonBase(Number n0,
                                    Number n1,
                                    BitCount minBitsCount)
```
    Возвращает интерфейс для работы с общим основанием чисел. Основание (тип чисел) береться такое чтоб не потерять точность вычислений.
    Алгоритм выбора:
    
    Числа (любое) не ограничено по точности ? unlimited(Number)
    
    ДА - Числа (любое) дробное ? ratioNumber(Number)
    
    ДА - Основание - BigDecimalNumbers
    НЕТ - Основание - BigIntegerNumbers
    
    НЕТ (число ограничено по кол-ву бит)
    Числа атомарные и их тип совпадает ?
    
    ДА - используется соответ атомарные реализации (AtomicIntegerNumbers, AtomicLongNumbers)
    НЕТ (числа не атомарные)
    Числа дробные ?
    
    ДА - Испольуется та реализация что даст большую точность: DoubleNumbers, FloatNumbers
    НЕТ - Испольуется та реализация что даст большую точность: ByteNumbers, ShortNumbers, IntegerNumbers, LongNumbers
    Parameters:
    
    n0 - Число А
    
    n1 - Число Б
    
    minBitsCount - (может быть null, тогда см BitCount.max(Number, Number)
    
    Returns:
    
    Возвращает интерфейс с минимальной потерей точности
  - base
```
public static BaseNumbers.BaseNumbersBuilder base()
```
    Выбор общего основания
    
    Returns:
    
    общее основание
  - zero
```
public Number zero()
```
    Description copied from interface: Numbers
    
    Возвращает нулевое число
    
    Specified by:
    
    zero in interface Numbers<Number>
    
    Returns:
    
    ноль
  - one
```
public Number one()
```
    Description copied from interface: Numbers
    
    Возвращает единицу
    
    Specified by:
    
    one in interface Numbers<Number>
    
    Returns:
    
    единица
  - zero
```
public boolean zero(Number n)
```
    Description copied from interface: Numbers
    
    Проверяет что число является нулем
    
    Specified by:
    
    zero in interface Numbers<Number>
    
    Parameters:
    
    n - число
    
    Returns:
    
    true - число является нулем
  - undefined
```
public boolean undefined(Number n)
```
    Description copied from interface: Numbers
    
    Проверяет что число не определенно
    
    Specified by:
    
    undefined in interface Numbers<Number>
    
    Parameters:
    
    n - число
    
    Returns:
    
    true - число не определенно
  - infinity
```
public boolean infinity(Number n)
```
    Description copied from interface: Numbers
    
    Проверяет что число является бесконечностью
    
    Specified by:
    
    infinity in interface Numbers<Number>
    
    Parameters:
    
    n - число
    
    Returns:
    
    true - число является бесконечностью
  - add
```
public Number add(Number a,
                  Number b)
```
    Description copied from interface: Numbers
    
    Сложение чисел
    
    Specified by:
    
    add in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    сумма чисел
  - sub
```
public Number sub(Number a,
                  Number b)
```
    Description copied from interface: Numbers
    
    Вычитание чисел
    
    Specified by:
    
    sub in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    разность чисел
  - mul
```
public Number mul(Number a,
                  Number b)
```
    Description copied from interface: Numbers
    
    Умножение чисел
    
    Specified by:
    
    mul in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    результат умножение
  - div
```
public Number div(Number a,
                  Number b)
```
    Description copied from interface: Numbers
    
    Деление чисел
    
    Specified by:
    
    div in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    результат деления
  - remainder
```
public Number remainder(Number a,
                        Number b)
```
    Description copied from interface: Numbers
    
    Остаток от деления
    
    Specified by:
    
    remainder in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    остаток
  - equals
```
public boolean equals(Number a,
                      Number b)
```
    Description copied from interface: Numbers
    
    Сравнивает два числа на равность
    
    Specified by:
    
    equals in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    true - числа равны
  - more
```
public boolean more(Number a,
                    Number b)
```
    Description copied from interface: Numbers
    
    Сравннвает числа
    
    Specified by:
    
    more in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    true - число а больше б
  - less
```
public boolean less(Number a,
                    Number b)
```
    Description copied from interface: Numbers
    
    Сравннвает числа
    
    Specified by:
    
    less in interface Numbers<Number>
    
    Parameters:
    
    a - число а
    
    b - число б
    
    Returns:
    
    true - число а меньше б
  - next
```
public Number next(Number n)
```
    Description copied from interface: Numbers
    
    Возвращает следующее число
    
    Specified by:
    
    next in interface Numbers<Number>
    
    Parameters:
    
    n - число
    
    Returns:
    
    следующее число
  - prev
```
public Number prev(Number n)
```
    Description copied from interface: Numbers
    
    Возвращает предыдущее число
    
    Specified by:
    
    prev in interface Numbers<Number>
    
    Parameters:
    
    n - число
    
    Returns:
    
    предыдущее число

Class BaseNumbers

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

minBitsCount

zero

one

Constructor Detail

BaseNumbers

BaseNumbers

Method Detail

integerNumber

ratioNumber

bitCount

unlimited

cast

singleBase

commonBase

commonBase

base

zero

one

zero

undefined

infinity

add

sub

mul

div

remainder

equals

more

less

next

prev