Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/sushi"

Index

Type aliases

Variables

Functions

Type aliases

MatrixLike

MatrixLike: Matrix | number | number[] | number[]

MatrixOrNumber

MatrixOrNumber: util.MatrixOrNumber

Variables

CL

CL: any = null

argmax

argmax: argmax = reduction.argmax

argmin

argmin: argmin = reduction.argmin

cat

cat: cat = shape_converter.cat

ceil

ceil: function = func_generator.make_unary_arith_func_all('Math.ceil(%a)')

Type declaration

end

end: number = -1

exp

exp: function = func_generator.make_unary_arith_func_all('Math.exp(%a)')

Type declaration

fix

fix: function = func_generator.make_unary_arith_func_all('(%a > 0 ? Math.floor(%a) : Math.ceil(%a))')

Type declaration

floor

floor: function = func_generator.make_unary_arith_func_all('Math.floor(%a)')

Type declaration

horzcat

horzcat: horzcat = shape_converter.horzcat

initcl_result

initcl_result: boolean = null

ipermute

ipermute: ipermute = shape_converter.ipermute

ldivide

ldivide: function = func_generator.make_binary_arith_func_all('%b / %a')

Type declaration

log

log: function = func_generator.make_unary_arith_func_all('Math.log(%a)')

Type declaration

max

max: max = reduction.max

mean

mean: mean = reduction.mean

min

min: min = reduction.min

minus

minus: function = func_generator.make_binary_arith_func_all('%a - %b')

Type declaration

mtimes

mtimes: mtimes = mul.mtimes

npyread

npyread: npyread = npy.npyread

npysave

npysave: npysave = npy.npysave

permute

permute: permute = shape_converter.permute

plus

plus: function = func_generator.make_binary_arith_func_all('%a + %b')

Type declaration

power

power: function = func_generator.make_binary_arith_func_all('Math.pow(%a,%b)')

Type declaration

prod

prod: prod = reduction.prod

rdivide

rdivide: function = func_generator.make_binary_arith_func_all('%a / %b')

Type declaration

repmat

repmat: repmat = shape_converter.repmat

require

require: any

std

std: std = reduction.std

sum

sum: sum = reduction.sum

t

t: transpose = transpose

times

times: function = func_generator.make_binary_arith_func_all('%a * %b')

Type declaration

transpose

transpose: transpose = shape_converter.transpose

typedarray2mat

typedarray2mat: typedarray2mat = Matrix.typedarray2mat

uminus

uminus: function = func_generator.make_unary_arith_func_all('-%a')

Type declaration

uplus

uplus: function = func_generator.make_unary_arith_func_all('+%a')

Type declaration

variance

variance: variance = reduction.variance

vertcat

vertcat: vertcat = shape_converter.vertcat

Functions

_singlemat2number

allclose

  • Compares if all the elements of two matrices are close. One of the input can be scalar number. See also isclose

    Parameters

    Returns boolean

    true if all elements of isclose(A, B) are 1.

autodestruct

  • autodestruct(f: function): any

  • Parameters

    • f: function
        • (): any

        • Returns any

    Returns any

colonvec

  • colonvec(start: number, stop_step: number, stop?: number, klass?: string): Matrix

  • Parameters

    • start: number
    • stop_step: number
    • Optional stop: number
    • Default value klass: string = "single"

    Returns Matrix

devicetype

  • devicetype(A: Matrix): string

eq

eye

gather

ge

gpuArray

gt

initcl

  • initcl(): boolean

isclose

  • Compares if elements of two matrices are close. One of the input can be scalar number.

    Parameters

    • A: MatrixOrNumber

      Input matrix.

    • B: MatrixOrNumber

      Input matrix.

    • Default value rtol: number = 0.00001
    • Default value atol: number = 1e-8
    • Default value equal_nan: boolean = false

    Returns Matrix

    logical matrix. 1 if abs(A(i) - B(i)) <= atol + rtol * abs(B(i)).

iscolumn

  • iscolumn(A: Matrix): boolean

isempty

isequal

  • isequal(...As: Matrix[]): boolean

  • Checks if all matrices are equal. Assumes NaN is not equal to NaN.

    Parameters

    • Rest ...As: Matrix[]

      Input matrices.

    Returns boolean

    true if all matrices are the same regarding both size and value of elements.

isequaln

  • isequaln(...As: Matrix[]): boolean

  • Checks if all matrices are equal. Assumes NaN is equal to NaN.

    Parameters

    • Rest ...As: Matrix[]

      Input matrices.

    Returns boolean

    true if all matrices are the same regarding both size and value of elements.

ismatrix

  • ismatrix(A: Matrix): boolean

isrow

isscalar

  • isscalar(A: Matrix): boolean

isvector

  • isvector(A: Matrix): boolean

jsa2mat

  • jsa2mat(A: any[], one_d_column?: boolean, klass?: string): Matrix

  • Parameters

    • A: any[]
    • Optional one_d_column: boolean
    • Optional klass: string

    Returns Matrix

jsaequal

  • jsaequal(a: any[], b: any[]): boolean

klass

  • klass(object: Matrix): string

le

length

lt

mat2jsa

  • mat2jsa(A: Matrix, one_d_flatten?: boolean): any[]

  • Parameters

    • A: Matrix
    • Default value one_d_flatten: boolean = false

    Returns any[]

ndims

ne

numel

ones

  • ones(...args: any[]): Matrix

rand

  • rand(...args: any[]): Matrix

randi

  • randi(imax: number | number[], ...args: any[]): Matrix

randn

  • randn(...args: any[]): Matrix

reshape

size

sizejsa

  • sizejsa(X: Matrix): number[]

squeeze

sub2ind

  • sub2ind(matrixSize: Matrix | number[], ...dimSub: number[]): number

  • Parameters

    • matrixSize: Matrix | number[]
    • Rest ...dimSub: number[]

    Returns number

zeros

  • zeros(...args: any[]): Matrix

Generated using TypeDoc