UnitVector

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

class

UnitVector

UnitVector.php:14

Represent a unit with its power and its factor: {factor} * ({unit}^{power})

class MMO\math\helpers\UnitVector implements Stringable, MMO\math\interfaces\iWithUnits

Namespace: MMO\math\helpers
Implements: Stringable, iWithUnits

Index

	factor
	power
	unit
	divideBy($factor)
	getFactor()
	hasUnits()	Usefull for polynome to determine if variable (number) has units
	isConstant()
	isCustom()
	isPrimitive()
	isSameUnits($unit, $checkPower)
	isTime()
	multiplyBy($factor)
	name()
	numberValue()	Get the value of this vector.
	powerBy($power)
	toNumber()
	toPrimitives()
	unitFactor($unit)
	units()	Transform this vector into Units Warning: for polynome units, the number's units ius returned
	__construct($unit, $power, $factor)
	__toString()

Properties3

factor

float $factor

Type: float

power

float $power

Type: float

unit

MMO\math\interfaces\iUnit|string $unit

Type: iUnit | string

Methods18

divideBy($factor)

UnitVector.php:151

function divideBy( MMO\math\interfaces\iUnit|self|MMO\math\helpers\Units|string|int|float $factor ): self|MMO\math\helpers\Units

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

getFactor()

UnitVector.php:81

function getFactor(): float

returns

hasUnits()

UnitVector.php:36

Usefull for polynome to determine if variable (number) has units

function hasUnits(): bool

returns

isConstant()

UnitVector.php:89

function isConstant(): bool

returns

isCustom()

UnitVector.php:93

function isCustom(): bool

returns

isPrimitive()

UnitVector.php:101

function isPrimitive(): bool

returns

isSameUnits($unit, $checkPower)

UnitVector.php:118

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

$unit	iUnit \| Units \| self \| string
$checkPower = true	bool
returns	bool

isTime()

UnitVector.php:97

function isTime(): bool

returns

multiplyBy($factor)

UnitVector.php:128

function multiplyBy( MMO\math\interfaces\iUnit|self|MMO\math\helpers\Units|string|int|float $factor ): self|MMO\math\helpers\Units

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

name()

UnitVector.php:49

function name(): string

returns

numberValue()

UnitVector.php:72

Get the value of this vector.

function numberValue(): int|float|null

Used by polynome when the unit is a UnitNumber

returns

int | float | null

powerBy($power)

UnitVector.php:177

function powerBy(float $power): self

$power	float
returns	self

toNumber()

UnitVector.php:53

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

returns

ArithmeticOperation | Number | float

toPrimitives()

UnitVector.php:105

function toPrimitives(): array

returns

unitFactor($unit)

UnitVector.php:85

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

units()

UnitVector.php:45

Transform this vector into Units Warning: for polynome units, the number's units ius returned

function units(): ?MMO\math\helpers\Units

returns

__construct($unit, $power, $factor)

UnitVector.php:20

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

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

__toString()

UnitVector.php:26

function __toString(): string

returns