Scalar - Documentation

Constructor

new Scalar(v)

Source:

scalar.js, line 15

Properties:

Name	Type	Description
`value`	BigFraction \| BigFloat \| Complex	The underlying numeric value.
`level`	number	The type promotion level (0, 1, or 2).

Parameters:

Name	Type	Description
`v`	number \| bigint \| string \| BigFraction \| BigFloat \| Complex \| Scalar

Classes

Scalar

Methods

abs() → {Scalar}

Source:

scalar.js, line 149

Returns:

Type: Scalar

acos() → {Scalar}

Source:

scalar.js, line 183

Returns:

Type: Scalar

acosh() → {Scalar}

Source:

scalar.js, line 195

Returns:

Type: Scalar

add(other)

Source:

scalar.js, line 118

Parameters:

Name	Type	Description
`other`	Scalar \| any	@returns {Scalar}

asin() → {Scalar}

Source:

scalar.js, line 181

Returns:

Type: Scalar

asinh() → {Scalar}

Source:

scalar.js, line 193

Returns:

Type: Scalar

atan() → {Scalar}

Source:

scalar.js, line 185

Returns:

Type: Scalar

atanh() → {Scalar}

Source:

scalar.js, line 197

Returns:

Type: Scalar

cmp(other) → {number}

Description:

Compares this scalar with another value.

Source:

scalar.js, line 208

Parameters:

Name	Type	Description
`other`	Scalar \| any

Returns:

-1 if this < other, 0 if this === other, 1 if this > other.

Type: number

cos() → {Scalar}

Source:

scalar.js, line 177

Returns:

Type: Scalar

cosh() → {Scalar}

Source:

scalar.js, line 189

Returns:

Type: Scalar

div(other)

Source:

scalar.js, line 124

Parameters:

Name	Type	Description
`other`	Scalar \| any	@returns {Scalar}

equals(other) → {boolean}

Description:

Checks for equality with another value.

Source:

scalar.js, line 220

Parameters:

Name	Type	Description
`other`	Scalar \| any

Returns:

Type: boolean

exp() → {Scalar}

Source:

scalar.js, line 171

Returns:

Type: Scalar

isAlmostZero() → {boolean}

Source:

scalar.js, line 147

Returns:

Type: boolean

isZero() → {boolean}

Source:

scalar.js, line 145

Returns:

Type: boolean

log() → {Scalar}

Source:

scalar.js, line 173

Returns:

Type: Scalar

mul(other)

Source:

scalar.js, line 122

Parameters:

Name	Type	Description
`other`	Scalar \| any	@returns {Scalar}

neg() → {Scalar}

Source:

scalar.js, line 143

Returns:

Type: Scalar

operatorAdd(b)

Source:

scalar.js, line 130

Parameters:

Name	Type	Description
`b`	Scalar \| any	@returns {Scalar}

operatorDiv(b)

Source:

scalar.js, line 136

Parameters:

Name	Type	Description
`b`	Scalar \| any	@returns {Scalar}

operatorMul(b)

Source:

scalar.js, line 134

Parameters:

Name	Type	Description
`b`	Scalar \| any	@returns {Scalar}

operatorNeg() → {Scalar}

Source:

scalar.js, line 140

Returns:

Type: Scalar

operatorPow(b)

Source:

scalar.js, line 138

Parameters:

Name	Type	Description
`b`	Scalar \| any	@returns {Scalar}

operatorSub(b)

Source:

scalar.js, line 132

Parameters:

Name	Type	Description
`b`	Scalar \| any	@returns {Scalar}

pow(other)

Source:

scalar.js, line 126

Parameters:

Name	Type	Description
`other`	Scalar \| any	@returns {Scalar}

sin() → {Scalar}

Source:

scalar.js, line 175

Returns:

Type: Scalar

sinh() → {Scalar}

Source:

scalar.js, line 187

Returns:

Type: Scalar

sqrt() → {Scalar}

Source:

scalar.js, line 199

Returns:

Type: Scalar

sub(other)

Source:

scalar.js, line 120

Parameters:

Name	Type	Description
`other`	Scalar \| any	@returns {Scalar}

tan() → {Scalar}

Source:

scalar.js, line 179

Returns:

Type: Scalar

tanh() → {Scalar}

Source:

scalar.js, line 191

Returns:

Type: Scalar

toString(radixopt, precisionopt, prettyopt) → {string}

Description:

Converts the scalar to a string.

Source:

scalar.js, line 233

Parameters:

Name	Type	Attributes	Default	Description
`radix`	number	<optional>	`10`
`precision`	number	<optional>	`-1`
`pretty`	boolean	<optional>	`false`	pretty print

Returns:

Type: string

(static) fromString(str) → {Scalar}

Description:

Parses string and determines correct type/level.

Source:

scalar.js, line 242

Parameters:

Name	Type	Description
`str`	string

Returns:

Type: Scalar

(static) getLevel(v) → {number}

Description:

Determine the level of a raw math object.

Source:

scalar.js, line 58

Parameters:

Name	Type	Description
`v`	any	The value to check.

Returns:

The promotion level.

Type: number

(static) promote(v, targetLevel) → {any}

Description:

Promotes a raw value to the target level.

Source:

scalar.js, line 71

Parameters:

Name	Type	Description
`v`	any	The value to promote.
`targetLevel`	number	The target promotion level.

Returns:

The promoted value.

Type: any