Header menu logo bristlecone

Typed Module

Functions and values

Function or value Description

addScalar a b

Full Usage: addScalar a b

Parameters:
Returns: TypedTensor<Scalar, 'u>
a : TypedTensor<Scalar, 'u>
b : TypedTensor<Scalar, 'u>
Returns: TypedTensor<Scalar, 'u>

addVector a b

Full Usage: addVector a b

Parameters:
Returns: TypedTensor<Vector, 'u>
a : TypedTensor<Vector, 'u>
b : TypedTensor<Vector, 'u>
Returns: TypedTensor<Vector, 'u>

broadcastScalarToVector s len

Full Usage: broadcastScalarToVector s len

Parameters:
Returns: TypedTensor<Vector, 'u>
s : TypedTensor<Scalar, 'u>
len : int
Returns: TypedTensor<Vector, 'u>

divScalar a b

Full Usage: divScalar a b

Parameters:
Returns: TypedTensor<Scalar, MeasureProduct<MeasureInverse<'v>, MeasureProduct<'u, MeasureOne>>>

divVectorByScalar v s

Full Usage: divVectorByScalar v s

Parameters:
Returns: TypedTensor<Vector, MeasureProduct<MeasureInverse<'v>, MeasureProduct<'u, MeasureOne>>>

dot a b

Full Usage: dot a b

Parameters:
Returns: TypedTensor<Scalar, MeasureProduct<MeasureProduct<'u, 'u>, MeasureOne>>

filterByMask mask v

Full Usage: filterByMask mask v

Parameters:
Returns: TypedTensor<'a, 'u0>

Filter a vector tensor by a boolean mask. The mask length must match the vector length.

mask : bool[]
v : TypedTensor<Vector, 'u>
Returns: TypedTensor<'a, 'u0>

itemAt i v

Full Usage: itemAt i v

Parameters:
Returns: TypedTensor<Scalar, 'u>
i : int
v : TypedTensor<Vector, 'u>
Returns: TypedTensor<Scalar, 'u>

length t

Full Usage: length t

Parameters:
Returns: int
t : TypedTensor<Vector, 'u>
Returns: int

logScalar a

Full Usage: logScalar a

Parameters:
Returns: TypedTensor<Scalar, MeasureOne>

logVector a

Full Usage: logVector a

Parameters:
Returns: TypedTensor<Vector, MeasureOne>

matMul a b

Full Usage: matMul a b

Parameters:
Returns: TypedTensor<Matrix, MeasureProduct<'v, MeasureProduct<'u, MeasureOne>>>

minusScalar a b

Full Usage: minusScalar a b

Parameters:
Returns: TypedTensor<Scalar, 'u>
a : TypedTensor<Scalar, 'u>
b : TypedTensor<Scalar, 'u>
Returns: TypedTensor<Scalar, 'u>

mulScalar a b

Full Usage: mulScalar a b

Parameters:
Returns: TypedTensor<Scalar, MeasureProduct<'v, MeasureProduct<'u, MeasureOne>>>

ofMatrix data

Full Usage: ofMatrix data

Parameters:
Returns: TypedTensor<Matrix, 'u>
data : float<'u>[,]
Returns: TypedTensor<Matrix, 'u>

ofScalar value

Full Usage: ofScalar value

Parameters:
Returns: TypedTensor<Scalar, 'u>
value : float<'u>
Returns: TypedTensor<Scalar, 'u>

ofVector data

Full Usage: ofVector data

Parameters:
Returns: TypedTensor<Vector, 'u>
data : float<'u>[]
Returns: TypedTensor<Vector, 'u>

prepend1D head tail

Full Usage: prepend1D head tail

Parameters:
Returns: TypedTensor<Vector, 'u>

Prepend a scalar to the front of a vector, keeping it differentiable

head : TypedTensor<Scalar, 'u>
tail : TypedTensor<Vector, 'u>
Returns: TypedTensor<Vector, 'u>

retype t

Full Usage: retype t

Parameters:
Returns: TypedTensor<'Shape, 'v>

Change the unit-of-measure phantom type of a TypedTensor without altering its value. This is purely a compile-time reinterpretation; the underlying DiffSharp tensor is unchanged.

t : TypedTensor<'Shape, 'u>
Returns: TypedTensor<'Shape, 'v>

scale s v

Full Usage: scale s v

Parameters:
Returns: TypedTensor<Vector, MeasureProduct<'b, MeasureProduct<'a, MeasureOne>>>

sqrtScalar x

Full Usage: sqrtScalar x

Parameters:
Returns: TypedTensor<Scalar, 'u>

square x

Full Usage: square x

Parameters:
Returns: TypedTensor<Scalar, MeasureProduct<MeasureProduct<'u, 'u>, MeasureOne>>

squareVector x

Full Usage: squareVector x

Parameters:
Returns: TypedTensor<Vector, MeasureProduct<MeasureProduct<'u, 'u>, MeasureOne>>

stack1D items

Full Usage: stack1D items

Parameters:
Returns: TypedTensor<Vector, 'u>
items : TypedTensor<Scalar, 'u>[]
Returns: TypedTensor<Vector, 'u>

subVector a b

Full Usage: subVector a b

Parameters:
Returns: TypedTensor<Vector, 'u>
a : TypedTensor<Vector, 'u>
b : TypedTensor<Vector, 'u>
Returns: TypedTensor<Vector, 'u>

sumVector a

Full Usage: sumVector a

Parameters:
Returns: TypedTensor<Scalar, 'u>
a : TypedTensor<Vector, 'u>
Returns: TypedTensor<Scalar, 'u>

tail v

Full Usage: tail v

Parameters:
Returns: TypedTensor<Vector, 'u>
v : TypedTensor<Vector, 'u>
Returns: TypedTensor<Vector, 'u>

toFloatArray v

Full Usage: toFloatArray v

Parameters:
Returns: float<'u>[]
v : TypedTensor<Vector, 'u>
Returns: float<'u>[]

toFloatScalar t

Full Usage: toFloatScalar t

Parameters:
Returns: float<'u>
t : TypedTensor<Scalar, 'u>
Returns: float<'u>

toFloatValueAt i t

Full Usage: toFloatValueAt i t

Parameters:
Returns: float<'u>
i : int
t : TypedTensor<Vector, 'u>
Returns: float<'u>

Type something to start searching.