CloudCastle UnitConvertor

Quantity

in package

• Application

implements JsonSerializable, Stringable

Иммутабельная величина: значение + единица измерения.

Table of Contents

Interfaces

JsonSerializable

Stringable

Properties

$converter  : Converter

$unitObject  : Unit

$value  : float

Methods

__toString()  : string

Строковое представление: «5.25 km».

abs()  : self

Абсолютное значение.

add()  : self

Сложение. Числовой операнд трактуется в единице этой величины.

avg()  : self

Среднее арифметическое набора (в единице первой величины).

ceil()  : self

Округление вверх.

code()  : string

Код единицы измерения.

compareTo()  : int

Трёхстороннее сравнение с конверсией операнда к этой единице.

div()  : self

Деление на скаляр или величину (размерностный анализ).

equals()  : bool

Равенство с допуском (в этой единице).

floor()  : self

Округление вниз.

format()  : string

Форматирует величину: «5,25 км» (локализация и плюрализация — Formatter).

fromArray()  : self

Восстанавливает величину из массива {@see Quantity::toArray()}.

greaterThan()  : bool

Строго больше.

greaterThanOrEqual()  : bool

Больше или равно.

humanize()  : string

Человекочитаемое представление в лучшей единице: 1500 м → «1,5 км».

in()  : self

Создаёт величину для конкретного конвертера (используется конвертером).

invert()  : self

Обратная величина: 1/x с обращением размерности.

isNegative()  : bool

Отрицательное ли значение.

isPositive()  : bool

Положительное ли значение.

isSameDimension()  : bool

Совпадают ли размерности величин.

isZero()  : bool

Нулевое ли значение.

jsonSerialize()  : array{value: float, unit: string}

Сериализация в JSON.

lessThan()  : bool

Строго меньше.

lessThanOrEqual()  : bool

Меньше или равно.

max()  : self

Максимальная величина набора.

min()  : self

Минимальная величина набора.

mul()  : self

Умножение на скаляр или величину (размерностный анализ).

negate()  : self

Смена знака.

of()  : self

Создаёт величину через общий конвертер.

parse()  : self

Разбирает строку «5.5 km» или составную «5 ft 3 in» (общий конвертер).

pow()  : self

Возведение в целую степень (размерность возводится вместе со значением).

round()  : self

Округление значения.

simplify()  : self

Автоматический выбор «лучшей» единицы той же системы: 1500 м → 1.5 км.

sub()  : self

Вычитание. Разность двух точек аффинной шкалы — дельта: 30 °C − 20 °C = 10 Δ°C; вычитание дельты сдвигает точку шкалы.

sum()  : self

Сумма набора величин (в единице первой).

to()  : self

Конвертирует величину в другую единицу.

toAll()  : array<string, self>

Величина во всех совместимых единицах категории или в заданных целях.

toArray()  : array{value: float, unit: string}

Сериализация в массив.

toBase()  : self

Конвертирует в базовую единицу категории.

toCompound()  : array<string, self>

Раскладывает величину на составные единицы: 1.5 ч → 1 ч 30 мин.

tryParse()  : self|null

Разбор без исключений: null при ошибке.

unit()  : Unit

Единица измерения.

value()  : float

Числовое значение.

__construct()  : mixed

affineDifference()  : self

Разность точек аффинной шкалы — дельта в парной дельта-единице.

assertScalable()  : void

Отклоняет масштабирование точек аффинных шкал (умножение 30 °C бессмысленно).

candidateScore()  : array{0: int, 1: float}

Ключ ранжирования кандидата: массивы сравниваются поэлементно, поэтому [0, x] (значение ≥1: меньше — лучше) всегда выигрывает у [1, −y] (значение <1: больше — лучше, ближе к единице).

derived()  : self

Строит величину результата размерностного анализа.

extremum()  : self

Общий поиск экстремума набора.

isSimplifyCandidate()  : bool

Пригодна ли единица для simplify: та же система, линейная, не дельта.

pickBestUnit()  : Unit, 1: float}

Ищет единицу той же системы, дающую значение, ближайшее к диапазону 1…999.

siValue()  : float

Значение в когерентных СИ-единицах размерности.

withDeltaApplied()  : self

Прибавляет дельту к точке шкалы (знак задаёт направление).