vector.scalaroperations.getadditiveinverse.md

Home > @josh-brown/vector > ScalarOperations > getAdditiveInverse

ScalarOperations.getAdditiveInverse() method

Returns the unique value that, when added to x, returns the additive identity

Signature:

abstract getAdditiveInverse(x: S): S;

Parameters

Parameter	Type	Description
x	S

Returns:

S

The additive inverse

Remarks

In other words, addScalars(scalar, getAdditiveInverse(scalar)) === getAdditiveIdentity() is true for x