Units

MMO\math\helpers · 1 symbol · generated 30 Sep 2026

class

Units

Holds a list of UnitVector

class MMO\math\helpers\Units implements Countable, Stringable, ArrayAccess, IteratorAggregate

Namespace: MMO\math\helpers
Implements: Countable, Stringable, ArrayAccess, IteratorAggregate

Index

	content
	clear()
	Compatible($a, $b) static
	convertFactor($to)	Get the conversion factor between two units WARNING: units MUST be compatible
	count()
	debugName()
	divideBy($factor)
	divideUnit($unit, $power, $factor)
	From($value, $clone) static
	getFactor()
	getIterator()	\IteratorAggregate::getIterator
	getUnit($value, $create)	Get a unit vector from a unit
	getUnits()
	hasUnit($value)
	isCompatible($units)	Tests if compatible with another units.
	isConstant()
	isPrimitive()
	isSameUnits($units, $checkPower)
	isTime()
	LoopBinomialPower($power, $vectors) static	Expand a binomial to the power using the binomial theorem (a+b+...)^n
	multiplyBy($factor)	Multiply this unit by a factor or another unit
	multiplyUnit($unit, $power, $factor)
	numberValue()	Get the value of these vectors.
	offsetExists($key)	\ArrayAccess::offsetExists
	offsetGet($key)	\ArrayAccess::offsetGet
	offsetSet($key, $value)	\ArrayAccess::offsetSet
	offsetUnset($key)	\ArrayAccess::offsetUnset
	powerBy($power)
	removeUnit($unit)
	standard()	Return primitives units or a float factor if it has no units
	toNumber()
	unitFactor($unit)
	__clone()
	__construct($units)
	__toString()

Properties1

content

protected array $content = []

Type: array

Methods34

clear()

Units.php:143

function clear(): void

returns

void

Compatible($a, $b)

staticUnits.php:26

static function Compatible(mixed $a, mixed $b): bool

$a	mixed
$b	mixed
returns	bool

convertFactor($to)

Units.php:348

Get the conversion factor between two units WARNING: units MUST be compatible

function convertFactor(?self $to): float

$to	null \| self
returns	float

count()

Units.php:131

function count(): int

returns

int

debugName()

Units.php:139

function debugName(): string

returns

string

divideBy($factor)

Units.php:293

$factor	iUnit \| UnitVector \| self \| string \| int \| float
returns	self

divideUnit($unit, $power, $factor)

Units.php:261

function divideUnit( MMO\math\interfaces\iUnit|MMO\math\helpers\UnitVector|string $unit, float $power = 1.0, MMO\math\enums\cPrefix|float $factor = 1.0 ): MMO\math\helpers\UnitVector

$unit	iUnit \| UnitVector \| string
$power = 1.0	float
$factor = 1.0	cPrefix \| float
returns	UnitVector

From($value, $clone)

staticUnits.php:22

static function From(mixed $value, bool $clone = true): ?self

$value	mixed
$clone = true	bool
returns	null \| self

getFactor()

Units.php:154

function getFactor(): float

returns

float

getIterator()

Units.php:414

\IteratorAggregate::getIterator

function getIterator(): Traversable

returns

Traversable

getUnit($value, $create)

Units.php:217

Get a unit vector from a unit

function getUnit(MMO\math\interfaces\iUnit|string $value, bool $create = false): ?MMO\math\helpers\UnitVector

$value	iUnit \| string
$create = false	bool
returns	null \| UnitVector

getUnits()

Units.php:191

function getUnits(): array

returns

array

hasUnit($value)

Units.php:231

function hasUnit(MMO\math\interfaces\iUnit|string $value): bool

$value	iUnit \| string
returns	bool

isCompatible($units)

Units.php:378

Tests if compatible with another units.

function isCompatible(?self $units): bool

Units are compatible when their standard units are the same with the same powers. Factor are not checked for compatibility.

$units	null \| self
returns	bool

isConstant()

Units.php:147

function isConstant(): bool

returns

bool

isPrimitive()

Units.php:386

function isPrimitive(): bool

returns

bool

isSameUnits($units, $checkPower)

Units.php:195

function isSameUnits( MMO\math\interfaces\iUnit|MMO\math\helpers\UnitVector|self|string $units, bool $checkPower = true ): bool

$units	iUnit \| UnitVector \| self \| string
$checkPower = true	bool
returns	bool

isTime()

Units.php:393

function isTime(): bool

returns

bool

LoopBinomialPower($power, $vectors)

staticUnits.php:49

Expand a binomial to the power using the binomial theorem (a+b+...)^n

static function LoopBinomialPower(int $power, MMO\math\helpers\UnitVector|self|int|float ...$vectors): Generator

See: https://en.wikipedia.org/wiki/Binomial_theorem

$power	int
...$vectors	UnitVector \| self \| int \| float
returns	Generator

foreach (\MMO\math\helpers\Units::LoopBinomialPower(2, new UnitVector('a'), new UnitVector('b'), new UnitVector('c')) as $unit) { echo ' + ' . $unit; } => + a² + b² + c² + 2bc + 2ac + 2ab

multiplyBy($factor)

Units.php:281

Multiply this unit by a factor or another unit

$factor	iUnit \| UnitVector \| self \| string \| int \| float
returns	self

multiplyUnit($unit, $power, $factor)

Units.php:245

function multiplyUnit( MMO\math\interfaces\iUnit|MMO\math\helpers\UnitVector|string $unit, float $power = 1.0, MMO\math\enums\cPrefix|float $factor = 1.0 ): MMO\math\helpers\UnitVector

$unit	iUnit \| UnitVector \| string
$power = 1.0	float
$factor = 1.0	cPrefix \| float
returns	UnitVector

numberValue()

Units.php:180

Get the value of these vectors.

function numberValue(): int|float|null

Used by polynome when the unit is a UnitNumber

returns

int | float | null

offsetExists($key)

Units.php:459

\ArrayAccess::offsetExists

function offsetExists(mixed $key): bool

$key	mixed
returns	bool

offsetGet($key)

Units.php:429

\ArrayAccess::offsetGet

function offsetGet(mixed $key): mixed

$key	mixed
returns	mixed

offsetSet($key, $value)

Units.php:440

\ArrayAccess::offsetSet

function offsetSet(mixed $key, mixed $value): void

$key	mixed
$value	mixed
returns	void

offsetUnset($key)

Units.php:421

\ArrayAccess::offsetUnset

function offsetUnset(mixed $key): void

$key	mixed
returns	void

powerBy($power)

Units.php:305

function powerBy(float $power): self

$power	float
returns	self

removeUnit($unit)

Units.php:235

function removeUnit(MMO\math\interfaces\iUnit|string $unit): ?MMO\math\helpers\UnitVector

$unit	iUnit \| string
returns	null \| UnitVector

standard()

Units.php:321

Return primitives units or a float factor if it has no units

function standard(): static|float

returns

static | float

toNumber()

Units.php:162

function toNumber(): MMO\math\helpers\Number|MMO\math\operations\ArithmeticOperation

returns

Number | ArithmeticOperation

unitFactor($unit)

Units.php:266

function unitFactor(MMO\math\interfaces\iUnit|string|null $unit = null): MMO\math\operations\ArithmeticOperation|MMO\math\helpers\Number|float

$unit = null	iUnit \| string \| null
returns	ArithmeticOperation \| Number \| float

__clone()

Units.php:125

function __clone()

__construct($units)

Units.php:18

function __construct(MMO\math\interfaces\iUnit|MMO\math\helpers\UnitVector|string ...$units)

...$units

iUnit | UnitVector | string

__toString()

Units.php:135

function __toString(): string

returns

string