package nx

  1. Overview
  2. Docs
package nx
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Nx.InfixSource

Infix operators

Elementwise Arithmetic

Sourceval (+) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 + t2 is a synonym for add.

Sourceval (-) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 - t2 is a synonym for sub.

Sourceval (*) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 * t2 is a synonym for mul.

Sourceval (/) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 / t2 is a synonym for div.

Sourceval (**) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 ** t2 is a synonym for pow.

Scalar-right Arithmetic

Sourceval (+$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t +$ scalar is a synonym for add_s.

Sourceval (-$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t -$ scalar is a synonym for sub_s.

Sourceval (*$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t *$ scalar is a synonym for mul_s.

Sourceval (/$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t /$ scalar is a synonym for div_s.

Sourceval (**$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t **$ scalar is a synonym for pow_s.

Comparisons

Sourceval (<) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 < t2 is a synonym for less

Sourceval (<>) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 <> t2 is a synonym for not_equal.

Sourceval (=) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 = t1 is a synonym for equal.

Sourceval (>) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 > t2 is a synonym for greater.

Sourceval (<=) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 <= t2 is a synonym for less_equal.

Sourceval (>=) : ('a, 'b) t -> ('a, 'b) t -> (bool, bool_elt) t

t1 >= t2 is a synonym for greater_equal.

Scalar Comparisons

Sourceval (=$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t =$ scalar compares each element with scalar for equality.

Sourceval (<>$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t <>$ scalar compares each element with scalar for inequality.

Sourceval (<$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t <$ scalar checks if each element is less than scalar.

Sourceval (>$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t >$ scalar checks if each element is greater than scalar.

Sourceval (<=$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t <=$ scalar checks if each element is less than or equal to scalar.

Sourceval (>=$) : ('a, 'b) t -> 'a -> (bool, bool_elt) t

t >=$ scalar checks if each element is greater than or equal to scalar.

Bitwise Operations

Sourceval (lxor) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 lxor t2 is a synonym for bitwise_xor.

Sourceval (lor) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 lor t2 is a synonym for bitwise_or.

Sourceval (land) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 land t2 is a synonym for bitwise_and.

Modulo Operations

Sourceval (%) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 % t2 is a synonym for mod_.

Sourceval (mod) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 mod t2 is a synonym for mod_.

Sourceval (%$) : ('a, 'b) t -> 'a -> ('a, 'b) t

t %$ scalar is a synonym for mod_s.

Boolean Mask Logic

Sourceval (^) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 ^ t2 is a synonym for logical_xor.

Sourceval (&&) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 && t2 is a synonym for logical_and.

Sourceval (||) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 || t2 is a synonym for logical_or.

Sourceval (~-) : ('a, 'b) t -> ('a, 'b) t

~-t is a synonym for logical_not.

Linear Algebra

Sourceval (@@) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 @@ t2 is a synonym for matmul.

Sourceval (/@) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 /@ t2 solves the linear system t1 * x = t2 for x.

Sourceval (**@) : ('a, 'b) t -> int -> ('a, 'b) t

t **@ n computes matrix power (t raised to the nth power).

Sourceval (<.>) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 <.> t2 is a synonym for dot.

Concatenation

Sourceval (@=) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 @= t2 concatenates t1 and t2 vertically (along axis 0).

Sourceval (@||) : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

t1 @|| t2 concatenates t1 and t2 horizontally (along axis 1).

Indexing and Slicing

Sourceval (.%{}) : ('a, 'b) t -> int list -> ('a, 'b) t

t.%{indices} is a synonym for get.

Sourceval (.%{}<-) : ('a, 'b) t -> int list -> ('a, 'b) t -> unit

t.%{indices} <- value is a synonym for set.

Sourceval (.${}) : ('a, 'b) t -> index list -> ('a, 'b) t

t.${slice} is a synonym for slice.

Sourceval (.${}<-) : ('a, 'b) t -> index list -> ('a, 'b) t -> unit

t.${slice} <- value is a synonym for set_slice.