package nx

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Creation
Properties
Index Operations
Transformations

package nx

nx
- Get started
- Input/Output Operations
- Library npy
  - Npy
    
    Batch_writer
    
    Header
    
    Npz
    
    Eq
    
    Kind
    
    Layout
- Library nx
  - Nx
- Library nx.c
  - Nx_c
- Library nx.core
  - Nx_core
    
    Dtype
    
    Shape
    
    View
    
    Backend_intf
    
    S
    
    Make_frontend
    
    B
    
    IntSet
    
    Error
- Library nx.io
  - Nx_io
- Library nx.native
  - Nx_native
- Library stb_image
  - Stb_image
- Library stb_image_write
  - Stb_image_write
- Sources
  - npy
    
    npy.ml
  - nx
    
    nx.ml
  - nx.c
    
    nx_c.ml
  - nx.core
    
    backend_intf.ml
    
    dtype.ml
    
    error.ml
    
    frontend.ml
    
    nx_core.ml
    
    nx_core__.ml
    
    shape.ml
    
    view.ml
  - nx.io
    
    nx_io.ml
    
    nx_io__.ml
    
    utils.ml
  - nx.native
    
    internal.ml
    
    nx_native.ml
    
    nx_native__.ml
    
    ops_binary.ml
    
    ops_cast.ml
    
    ops_im2col.ml
    
    ops_matmul.ml
    
    ops_reduce.ml
    
    ops_ternary.ml
    
    ops_threefry.ml
    
    ops_unary.ml
    
    parallel.ml
  - stb_image
    
    stb_image.ml
  - stb_image_write
    
    stb_image_write.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Nx_core.View`Source

Tensor view: strided view of tensor data.

Views describe how to interpret a linear buffer as a multi-dimensional array through shape, strides, and offset. Supports non-contiguous layouts and masked regions.

Sourcetype t

View encapsulating tensor layout information.

Creation

Source

val create : 
  ?offset:int ->
  ?strides:int array ->
  ?mask:(int * int) array ->
  Shape.t ->
  t

create ?offset ?strides ?mask shape constructs view.

Default offset is 0. Default strides are C-contiguous. Mask specifies valid ranges per dimension as (start, end) pairs.

Properties

Sourceval shape : t -> Shape.t

shape view returns dimension sizes.

Sourceval strides : t -> int array

strides view returns element strides per dimension.

Sourceval offset : t -> int

offset view returns starting position in buffer.

Sourceval ndim : t -> int

ndim view returns number of dimensions.

Sourceval numel : t -> int

numel view returns total elements.

Sourceval dim : int -> t -> int

dim axis view returns size of dimension axis.

raises Invalid_argument
if axis out of bounds

Sourceval stride : int -> t -> int

stride axis view returns stride of dimension axis.

raises Invalid_argument
if axis out of bounds

Sourceval mask : t -> (int * int) array option

mask view returns valid bounds per dimension if masked.

Sourceval is_c_contiguous : t -> bool

is_c_contiguous view tests for row-major contiguous layout.

Index Operations

Sourceval linear_index : t -> int array -> int

linear_index view indices computes buffer position.

Includes view's offset in result.

raises Invalid_argument
if rank mismatch

Sourceval is_valid : t -> int array -> bool

is_valid view indices checks mask bounds.

Returns true if no mask or indices within all bounds.

Transformations

Sourceval reshape : t -> Shape.t -> t

reshape view new_shape changes dimensions.

Returns view if possible, fails if requires reordering. Handles -1 dimensions and size-1 squeezing/unsqueezing.

raises Invalid_argument
if size mismatch

raises Failure
if cannot reshape strided view

Sourceval expand : t -> Shape.t -> t

expand view new_shape broadcasts singleton dimensions.

Size-1 dimensions become size-n with stride 0.

raises Invalid_argument
if non-singleton expansion attempted

Sourceval permute : t -> int array -> t

permute view axes reorders dimensions.

raises Invalid_argument
if invalid permutation

Sourceval shrink : t -> (int * int) array -> t

shrink view bounds restricts to sub-region.

Bounds are (start, end) pairs per dimension.

raises Invalid_argument
if bounds invalid

Sourceval pad : t -> (int * int) array -> t

pad view padding extends dimensions virtually.

Padding is (before, after) pairs. Creates mask for valid region.

raises Invalid_argument
if negative padding

Sourceval flip : t -> bool array -> t

flip view axes_to_flip reverses specified dimensions.

Adjusts strides to negative and updates offset.

raises Invalid_argument
if array length mismatch

package nx

Module Nx_core.ViewSource

Creation

Properties

Index Operations

Transformations

Module `Nx_core.View`Source