Class Tensor<T>

A matrix. This may be used to represent a tensor. While the syntactic representation of a tensor is that of nested arrays, the elements of the tensor are stored in a flattened manner. Presumambly, this makes things easier in the case when a Tensor is used as a square matrix.

Type Parameters

T extends U = U

Hierarchy (view full)

JsAtom
- Tensor

Index

Constructors

constructor

new Tensor<T>(dims, elems, pos?, end?): Tensor<T>
Type Parameters
- T extends U = U
Parameters
- dims: number[]
  The lengths of each dimension.
- elems: T[]
  The elements containing all the data.
- Optional pos: number
- Optional end: number
Returns Tensor<T>
Overrides JsAtom.constructor
- Defined in packages/atoms/src/tensor/Tensor.ts:44

Properties

`Optional` `Readonly` end

end?: number

`Readonly` name

name: string

`Optional` `Readonly` pos

pos?: number

`Readonly` type

type: "tensor" = "tensor"

Accessors

dims

get dims(): number[]
Returns number[]
- Defined in packages/atoms/src/tensor/Tensor.ts:49

elems

get elems(): T[]
Returns T[]
- Defined in packages/atoms/src/tensor/Tensor.ts:52

iscons

get iscons(): boolean
Returns boolean
Inherited from JsAtom.iscons
- Defined in packages/atoms/src/atom/JsAtom.ts:26

isnil

get isnil(): boolean
Returns boolean
Inherited from JsAtom.isnil
- Defined in packages/atoms/src/atom/JsAtom.ts:29

ndim

get ndim(): number
Returns number
- Defined in packages/atoms/src/tensor/Tensor.ts:63

nelem

get nelem(): number
Returns number
- Defined in packages/atoms/src/tensor/Tensor.ts:66

rank

get rank(): number
Returns number
- Defined in packages/atoms/src/tensor/Tensor.ts:55

Methods

addRef

addRef(): void
Returns void
Inherited from JsAtom.addRef
- Defined in packages/atoms/src/atom/JsAtom.ts:14

contains

contains(needle): boolean
Parameters
- needle: U
Returns boolean
Overrides JsAtom.contains
- Defined in packages/atoms/src/tensor/Tensor.ts:69

copyDimensions

copyDimensions(): number[]
Returns number[]
- Defined in packages/atoms/src/tensor/Tensor.ts:77

copyElements

copyElements(): T[]
Returns a copy of the data in this tensor.

Returns T[]
- Defined in packages/atoms/src/tensor/Tensor.ts:83

dim

dim(n): number
Returns the size of the specified dimension. This is the number of elements at the specified level of nesting.
Parameters
- n: number
  The zero-based index of the dimension.
Returns number
- Defined in packages/atoms/src/tensor/Tensor.ts:91

elem

elem(index): T
Parameters
- index: number
Returns T
- Defined in packages/atoms/src/tensor/Tensor.ts:100

equals

equals(other): boolean
Parameters
- other: U
Returns boolean
Overrides JsAtom.equals
- Defined in packages/atoms/src/tensor/Tensor.ts:103

everyElement

everyElement(predicate): boolean
Applies the predicate to every element of this tensor.
Parameters
- predicate: ((element) => boolean)
  The predicate applied.
  - - (element): boolean
    - Parameters
      element: T
      Returns boolean
Returns boolean
true if every element satisfies the predicate.
- Defined in packages/atoms/src/tensor/Tensor.ts:118

filterElements

filterElements(callbackfn): U[]
Parameters
- callbackfn: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: T
      index: number
      array: T[]
      Returns boolean
Returns U[]
- Defined in packages/atoms/src/tensor/Tensor.ts:121

map

map<X>(callbackfn): Tensor<X>
Type Parameters
- X extends U
Parameters
- callbackfn: ((value, index, array) => X)
  - - (value, index, array): X
    - Parameters
      value: T
      index: number
      array: T[]
      Returns X
Returns Tensor<X>
- Defined in packages/atoms/src/tensor/Tensor.ts:124

mapElements

mapElements<X>(callbackfn): X[]
Type Parameters
- X
Parameters
- callbackfn: ((value, index, array) => X)
  - - (value, index, array): X
    - Parameters
      value: T
      index: number
      array: T[]
      Returns X
Returns X[]
- Defined in packages/atoms/src/tensor/Tensor.ts:127

release

release(): void
Returns void
Inherited from JsAtom.release
- Defined in packages/atoms/src/atom/JsAtom.ts:15

sameDimensions

sameDimensions(other): boolean
Parameters
- other: Tensor<U>
Returns boolean
- Defined in packages/atoms/src/tensor/Tensor.ts:130

sliceDimensions

sliceDimensions(start?, end?): number[]
Parameters
- Optional start: number
- Optional end: number
Returns number[]
- Defined in packages/atoms/src/tensor/Tensor.ts:136

someElements

someElements(callbackfn): boolean
Parameters
- callbackfn: ((value, index, array) => boolean)
  - - (value, index, array): boolean
    - Parameters
      value: T
      index: number
      array: T[]
      Returns boolean
Returns boolean
- Defined in packages/atoms/src/tensor/Tensor.ts:139

toInfixString

toInfixString(): string
Returns string
- Defined in packages/atoms/src/tensor/Tensor.ts:142

toListString

toListString(): string
Returns string
- Defined in packages/atoms/src/tensor/Tensor.ts:145

toString

toString(): string
Returns string
Overrides JsAtom.toString
- Defined in packages/atoms/src/tensor/Tensor.ts:148

withElements

withElements<X>(elems): Tensor<X>
Returns a new tensor with the same dimensions as this, but with different elements. This element avoids the copy of the dims array.
Type Parameters
- X extends U
Parameters
- elems: X[]
Returns Tensor<X>
- Defined in packages/atoms/src/tensor/Tensor.ts:159

Class Tensor<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Tensor<T>

Properties

Optional Readonly end

Readonly name

Optional Readonly pos

Readonly type

Accessors

dims

Returns number[]

elems

Returns T[]

iscons

Returns boolean

isnil

Returns boolean

ndim

Returns number

nelem

Returns number

rank

Returns number

Methods

addRef

Returns void

contains

Parameters

Returns boolean

copyDimensions

Returns number[]

copyElements

Returns T[]

dim

Parameters

Returns number

elem

Parameters

Returns T

equals

Parameters

Returns boolean

everyElement

Parameters

Parameters

Returns boolean

Returns boolean

filterElements

Parameters

Parameters

Returns boolean

Returns U[]

map

Type Parameters

Parameters

Parameters

Returns X

Returns Tensor<X>

mapElements

Type Parameters

Parameters

Parameters

Returns X

Returns X[]

release

Returns void

sameDimensions

Parameters

Returns boolean

sliceDimensions

`Optional` `Readonly` end

`Readonly` name

`Optional` `Readonly` pos

`Readonly` type