meos.js

---

meos.js / FloatSet

Class: FloatSet

Defined in: core/types/collections/number/FloatSet.ts:31

An ordered set of distinct IEEE 754 double-precision floats.

Example

const s = FloatSet.fromString('{1.5, 3.0, 7.25}');
console.log(s.numValues());  // 3
console.log(s.startValue()); // 1.5
console.log(s.endValue());   // 7.25
s.free();

Extends

• MeosSet<number>

Constructors

Constructor

new FloatSet(inner): FloatSet;

Defined in: core/types/collections/base/MeosSet.ts:46

Parameters

inner

number

Returns

FloatSet

Inherited from

MeosSet.constructor

Accessors

inner

Get Signature

get inner(): number;

Defined in: core/types/collections/base/MeosSet.ts:58

Raw WASM heap pointer. Do not free this value directly; use free.

Returns

number

Inherited from

MeosSet.inner

Methods

[dispose]()

dispose: void;

Defined in: core/types/collections/base/MeosSet.ts:68

Implements the using resource-management protocol — calls free automatically.

Returns

void

Inherited from

MeosSet.[dispose]

---

asHexWKB()

asHexWKB(variant?): string;

Defined in: core/types/collections/base/MeosSet.ts:91

Serialises this set to a hex-encoded WKB string.

Parameters

variant?

number = 4

WKB encoding variant (default 4 = Extended WKB).

Returns

string

Inherited from

MeosSet.asHexWKB

---

ceil()

ceil(): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:115

Returns a new set with each value rounded up to the nearest integer.

Returns

FloatSet

---

contains()

contains(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:147

true if this contains every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.contains

---

copy()

copy(): this;

Defined in: core/types/collections/base/MeosSet.ts:76

Returns a deep copy of this set. The caller is responsible for calling free on the returned copy.

Returns

this

Inherited from

MeosSet.copy

---

degrees()

degrees(normalize?): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:128

Converts each value from radians to degrees.

Parameters

normalize?

boolean = false

If true, normalises the result to [0, 360) (default false).

Returns

FloatSet

---

distance()

distance(other): number;

Defined in: core/types/collections/number/FloatSet.ts:98

Returns the distance (gap) between this and other. Returns 0 if they share at least one element.

Parameters

other

FloatSet

Returns

number

Overrides

MeosSet.distance

---

endValue()

endValue(): number;

Defined in: core/types/collections/number/FloatSet.ts:78

Returns the largest (last) float in this set.

Returns

number

Overrides

MeosSet.endValue

---

eq()

eq(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:232

true if this and other contain the same elements.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.eq

---

floor()

floor(): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:120

Returns a new set with each value rounded down to the nearest integer.

Returns

FloatSet

---

free()

free(): void;

Defined in: core/types/collections/base/MeosSet.ts:63

Releases the WASM-allocated memory. Must be called when the object is no longer needed.

Returns

void

Inherited from

MeosSet.free

---

ge()

ge(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:257

true if this is greater than or equal to other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.ge

---

gt()

gt(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:252

true if this is strictly greater than other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.gt

---

hash()

hash(): number;

Defined in: core/types/collections/base/MeosSet.ts:105

32-bit integer hash of this set.

Returns

number

Inherited from

MeosSet.hash

---

intersection()

intersection(other): FloatSet | null;

Defined in: core/types/collections/base/MeosSet.ts:205

Returns the intersection of this and other, or null if they are disjoint. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

FloatSet | null

Inherited from

MeosSet.intersection

---

isAfter()

isAfter(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:174

true if every element of this is strictly greater than every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isAfter

---

isBefore()

isBefore(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:161

true if every element of this is strictly less than every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isBefore

---

isContainedIn()

isContainedIn(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:142

true if this is entirely contained within other (every element of this is in other).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isContainedIn

---

isOverOrAfter()

isOverOrAfter(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:182

true if this does not extend to the left of other (i.e. min(this) ≥ min(other)).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isOverOrAfter

---

isOverOrBefore()

isOverOrBefore(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:169

true if this does not extend to the right of other (i.e. max(this) ≤ max(other)).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isOverOrBefore

---

le()

le(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:247

true if this is less than or equal to other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.le

---

lt()

lt(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:242

true if this is strictly less than other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.lt

---

minus()

minus(other): FloatSet | null;

Defined in: core/types/collections/base/MeosSet.ts:214

Returns the part of this not in other, or null if the result is empty. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

FloatSet | null

Inherited from

MeosSet.minus

---

ne()

ne(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:237

true if this and other differ in at least one element.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.ne

---

numValues()

numValues(): number;

Defined in: core/types/collections/base/MeosSet.ts:100

Number of elements in this set.

Returns

number

Inherited from

MeosSet.numValues

---

overlaps()

overlaps(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:152

true if this and other share at least one element.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.overlaps

---

radians()

radians(): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:133

Converts each value from degrees to radians.

Returns

FloatSet

---

shiftScale()

shiftScale(
   shift, 
   width, 
   hasShift?, 
   hasWidth?): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:144

Returns a new set shifted and/or scaled along the float axis.

Parameters

shift

number

Amount to add to every element (ignored when hasShift is false).

width

number

New total width (ignored when hasWidth is false).

hasShift?

boolean = true

Set to false to skip shifting (default true).

hasWidth?

boolean = true

Set to false to skip scaling (default true).

Returns

FloatSet

---

startValue()

startValue(): number;

Defined in: core/types/collections/number/FloatSet.ts:73

Returns the smallest (first) float in this set.

Returns

number

Overrides

MeosSet.startValue

---

toIntSet()

toIntSet(): number;

Defined in: core/types/collections/number/FloatSet.ts:110

Truncates each float in this set to an integer and returns the raw WASM pointer. Use new IntSet(ptr) to obtain a typed object.

Returns

number

---

toSpan()

toSpan(): number;

Defined in: core/types/collections/base/MeosSet.ts:113

Returns the bounding span of this set as a raw WASM pointer. Use the appropriate Span constructor to obtain a typed object.

Returns

number

Inherited from

MeosSet.toSpan

---

toSpanSet()

toSpanSet(): number;

Defined in: core/types/collections/base/MeosSet.ts:121

Returns this set converted to a SpanSet as a raw WASM pointer. Use the appropriate SpanSet constructor to obtain a typed object.

Returns

number

Inherited from

MeosSet.toSpanSet

---

toString()

toString(maxdd?): string;

Defined in: core/types/collections/number/FloatSet.ts:64

Returns the WKT string representation (e.g. {1.5, 3.0, 7.25}).

Parameters

maxdd?

number = 15

Maximum decimal digits of precision (default 15).

Returns

string

Overrides

MeosSet.toString

---

union()

union(other): this;

Defined in: core/types/collections/base/MeosSet.ts:223

Returns the union of this and other. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

this

Inherited from

MeosSet.union

---

valueN()

valueN(n): number;

Defined in: core/types/collections/number/FloatSet.ts:86

Returns the n-th float (0-based index).

Parameters

n

number

0-based index (MEOS internally uses 1-based indexing).

Returns

number

Overrides

MeosSet.valueN

---

fromHexWKB()

static fromHexWKB(hexwkb): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:52

Deserialises a FloatSet from a hex-encoded WKB string produced by asHexWKB.

Parameters

hexwkb

string

Hex-encoded WKB string.

Returns

FloatSet

---

fromString()

static fromString(str): FloatSet;

Defined in: core/types/collections/number/FloatSet.ts:44

Parses a FloatSet from its WKT string representation.

Parameters

str

string

WKT string, e.g. "{1.5, 3.0, 7.25}".

Returns

FloatSet