AIDC Toolkit

Appearance

AIDC Toolkit / Utility / IdentityTransformer

Class: IdentityTransformer ​

Defined in: transformer.ts:283

Identity transformer. Values are transformed to themselves.

Extends ​

Constructors ​

Constructor ​

new IdentityTransformer(domain): IdentityTransformer

Defined in: transformer.ts:40

Constructor.

Parameters ​

domain ​

number | bigint

Domain.

Returns ​

IdentityTransformer

Inherited from ​

Transformer.constructor

Accessors ​

domain ​

Get Signature ​

get domain(): bigint

Defined in: transformer.ts:90

Get the domain.

Returns ​

bigint

Inherited from ​

Transformer.domain

Methods ​

get() ​

static get(domain, tweak?): Transformer

Defined in: transformer.ts:65

Get a transformer, constructing it if necessary. The type returned is IdentityTransformer if tweak is undefined, EncryptionTransformer if tweak is defined. Note that although an EncryptionTransformer with a zero tweak operates as an IdentityTransformer, EncryptionTransformer is still the type returned if a zero tweak is explicitly specified.

Parameters ​

domain ​

number | bigint

Domain.

tweak? ​

number | bigint

Tweak.

Returns ​

Transformer

Transformer.

Inherited from ​

Transformer.get

doForward() ​

protected doForward(value): bigint

Defined in: transformer.ts:287

Do the work of transforming a value forward.

Parameters ​

value ​

bigint

Value.

Returns ​

bigint

Transformed value.

Overrides ​

Transformer.doForward

doReverse() ​

protected doReverse(transformedValue): bigint

Defined in: transformer.ts:294

Do the work of transforming a value in reverse.

Parameters ​

transformedValue ​

bigint

Transformed value.

Returns ​

bigint

Value.

Overrides ​

Transformer.doReverse

forward() ​

Call Signature ​

forward(value): bigint

Defined in: transformer.ts:171

Transform a value forward.

Parameters ​
value ​

number | bigint

Value.

Returns ​

bigint

Transformed value.

Inherited from ​

Transformer.forward

Call Signature ​

forward<TOutput>(value, transformerCallback): TOutput

Defined in: transformer.ts:188

Transform a value forward and apply another transformation.

Type Parameters ​
TOutput ​

TOutput

Transformer callback output type.

Parameters ​
value ​

number | bigint

Value.

transformerCallback ​

IndexedCallback<bigint, TOutput>

Called with interim transformed value to transform it to its final value.

Returns ​

TOutput

Transformed value.

Inherited from ​

Transformer.forward

Call Signature ​

forward(values): Iterable<bigint>

Defined in: transformer.ts:200

Transform values forward.

Parameters ​
values ​

Iterable<number | bigint>

Values. If this is an instance of Sequence, the minimum and maximum values are validated prior to transformation. Otherwise, the individual values are validated at the time of each transformation.

Returns ​

Iterable<bigint>

Transformed values.

Inherited from ​

Transformer.forward

Call Signature ​

forward<TOutput>(values, transformerCallback): Iterable<TOutput>

Defined in: transformer.ts:218

Transform values forward and apply another transformation to each.

Type Parameters ​
TOutput ​

TOutput

Transformer callback output type.

Parameters ​
values ​

Iterable<number | bigint>

Values. If this is an instance of Sequence, the minimum and maximum values are validated prior to transformation. Otherwise, the individual values are validated at the time of each transformation.

transformerCallback ​

IndexedCallback<bigint, TOutput>

Called with each interim transformed value to transform it to its final value.

Returns ​

Iterable<TOutput>

Transformed values.

Inherited from ​

Transformer.forward

Call Signature ​

forward<TInput>(valueOrValues): TInput extends Iterable<number | bigint, any, any> ? Iterable<bigint, any, any> : bigint

Defined in: transformer.ts:220

Transform a value forward.

Type Parameters ​
TInput ​

TInput extends number | bigint | Iterable<number | bigint, any, any>

Parameters ​
valueOrValues ​

TInput extends Iterable<number | bigint, any, any> ? TInput : number | bigint

Returns ​

TInput extends Iterable<number | bigint, any, any> ? Iterable<bigint, any, any> : bigint

Transformed value.

Inherited from ​

Transformer.forward

Call Signature ​

forward<TInput, TOutput>(valueOrValues, transformerCallback): TInput extends Iterable<number | bigint, any, any> ? Iterable<TOutput, any, any> : TOutput

Defined in: transformer.ts:222

Transform a value forward.

Type Parameters ​
TInput ​

TInput extends number | bigint | Iterable<number | bigint, any, any>

TOutput ​

TOutput

Parameters ​
valueOrValues ​

TInput extends Iterable<number | bigint, any, any> ? TInput : number | bigint

transformerCallback ​

IndexedCallback<bigint, TOutput>

Returns ​

TInput extends Iterable<number | bigint, any, any> ? Iterable<TOutput, any, any> : TOutput

Transformed value.

Inherited from ​

Transformer.forward

reverse() ​

reverse(transformedValue): bigint

Defined in: transformer.ts:271

Transform a value in reverse.

Parameters ​

transformedValue ​

number | bigint

Transformed value.

Returns ​

bigint

Value.

Inherited from ​

Transformer.reverse