Package index • anvl

Array

Constructing and working with AnvlArrays

Construction

Functions for creating and initializing arrays

nv_array() nv_scalar() nv_matrix() nv_empty() nv_array_like() nv_scalar_like() nv_empty_like(): AnvlArray
nv_bool() nv_int8() nv_int16() nv_int32() nv_int64() nv_uint8() nv_uint16() nv_uint32() nv_uint64() nv_float32() nv_float64(): Create an Array of a Given Data Type
nv_fill() nv_fill_like(): Fill Constant
nv_iota() nv_iota_like(): Iota
nv_seq() nv_seq_like(): Sequence
nv_linspace() nv_linspace_like(): Evenly Spaced Sequence
nv_diag(): Diagonal Matrix
nv_eye() nv_eye_like(): Identity Matrix
as_anvl_array() as_anvl_arrays(): Convert to AnvlArray

Attributes

Functions for querying array properties

backend(): Get Backend Name of an Array
dtype(): Get the Data Type of an Array
shape(): Get the Shape of an Array
naxes(): Get the Number of Axes of an Array
axes(): Get the Axes of an Array
device(): Get the Device of an Array
platform(): Get the Platform Name of an Array or Buffer

Converters

Functions for converting arrays

as_array(): Convert to an R Array
as_raw(): Convert an Array to a Raw Vector
as.double(<AnvlArray>) as.integer(<AnvlArray>) as.integer64(<AnvlArray>) as.logical(<AnvlArray>) as.vector(<AnvlArray>): Coerce AnvlArray to an R Vector

Serialization

Functions for serializing and deserializing arrays

nv_save() nv_read(): Save and Read Arrays in a File
nv_serialize() nv_unserialize(): Serialize Arrays to Raw Bytes

Miscellaneous

is_arrayish(): Array-Like Objects
await(): Block Until an Async Operation Completes

Base R Generics

Methods for base R generics that have no nv_* twin. Every other generic is documented together with the nv_* function it delegates to.

dim(<AnvlArray>): Shape of an Array
length(<AnvlArray>): Number of Elements

Array API

User-facing nv_* functions for array operations

Type Conversion and Broadcasting

Functions for converting data types and broadcasting shapes

nv_convert(): Convert Data Type
nv_bitcast_convert(): Bitcast Conversion
nv_broadcast_scalars(): Broadcast Scalars to Common Shape
nv_broadcast_arrays(): Broadcast Arrays to a Common Shape
nv_broadcast_to(): Broadcast to Shape

Array Manipulation

Functions for reshaping and rearranging arrays

nv_reshape(): Reshape
nv_flatten(): Flatten
nv_aperm() nv_transpose() t(<AnvlArray>) aperm(<AnvlArray>): Transpose
nv_concatenate() c(<AnvlArray>): Concatenate
nv_rbind() nv_cbind() rbind(<AnvlArray>) cbind(<AnvlArray>): Combine Arrays by Rows or Columns
nv_static_slice(): Static Slice
nv_select(): Select Elements Along an Axis
nv_pad(): Pad
nv_rev() rev(<AnvlArray>): Reverse
nv_squeeze() nv_drop(): Squeeze
nv_unsqueeze(): Unsqueeze
`[`(<AnvlArray>) nv_subset(): Subset an Array
`[<-`(<AnvlArray>) nv_subset_assign(): Update Subset

Arithmetic Operations

Basic arithmetic operations on arrays

nv_add() `+`(<AnvlArray>): Addition
nv_sub() `-`(<AnvlArray>): Subtraction
nv_mul() `*`(<AnvlArray>): Multiplication
nv_div() `/`(<AnvlArray>): Division
nv_pow() `^`(<AnvlArray>): Power
nv_negate(): Negation
nv_remainder(): Remainder (Truncating)
nv_mod() `%%`(<AnvlArray>): Modulo (Flooring Remainder)
nv_floor_div() `%/%`(<AnvlArray>): Flooring Division

Comparison Operations

Element-wise comparison operations

nv_eq() `==`(<AnvlArray>): Equal
nv_ne() `!=`(<AnvlArray>): Not Equal
nv_gt() `>`(<AnvlArray>): Greater Than
nv_ge() `>=`(<AnvlArray>): Greater Than or Equal
nv_lt() `<`(<AnvlArray>): Less Than
nv_le() `<=`(<AnvlArray>): Less Than or Equal

Mathematical Functions

Mathematical and trigonometric functions

nv_abs() abs(<AnvlArray>): Absolute Value
nv_sqrt() sqrt(<AnvlArray>): Square Root
nv_rsqrt(): Reciprocal Square Root
nv_cbrt(): Cube Root
nv_exp() exp(<AnvlArray>): Exponential
nv_expm1() expm1(<AnvlArray>): Exponential Minus One
nv_log() log(<AnvlArray>): Natural Logarithm
nv_log1p() log1p(<AnvlArray>): Log Plus One
nv_log2() log2(<AnvlArray>): Base-2 Logarithm
nv_log10() log10(<AnvlArray>): Base-10 Logarithm
nv_sin() sin(<AnvlArray>): Sine
nv_cos() cos(<AnvlArray>): Cosine
nv_tan() tan(<AnvlArray>): Tangent
nv_sinpi() sinpi(<AnvlArray>): Sine of a Multiple of Pi
nv_cospi() cospi(<AnvlArray>): Cosine of a Multiple of Pi
nv_tanpi() tanpi(<AnvlArray>): Tangent of a Multiple of Pi
nv_asin() asin(<AnvlArray>): Arc Sine
nv_acos() acos(<AnvlArray>): Arc Cosine
nv_atan() atan(<AnvlArray>): Arc Tangent
nv_atan2(): Arctangent 2
nv_sinh() sinh(<AnvlArray>): Hyperbolic Sine
nv_cosh() cosh(<AnvlArray>): Hyperbolic Cosine
nv_tanh() tanh(<AnvlArray>): Hyperbolic Tangent
nv_asinh() asinh(<AnvlArray>): Inverse Hyperbolic Sine
nv_acosh() acosh(<AnvlArray>): Inverse Hyperbolic Cosine
nv_atanh() atanh(<AnvlArray>): Inverse Hyperbolic Tangent
nv_sign() sign(<AnvlArray>): Sign
nv_floor() floor(<AnvlArray>): Floor
nv_ceiling() ceiling(<AnvlArray>): Ceiling
nv_trunc() trunc(<AnvlArray>): Truncate
nv_round(): Round
nv_plogis(): Logistic (Sigmoid)
nv_erf(): Error Function
nv_erfc(): Complementary Error Function
nv_erf_inv(): Inverse Error Function
nv_gamma() gamma(<AnvlArray>): Gamma Function
nv_digamma() digamma(<AnvlArray>): Digamma
nv_lgamma() lgamma(<AnvlArray>): Log-Gamma
nv_psigamma() trigamma(<AnvlArray>): Psigamma
nv_is_finite() is.finite(<AnvlArray>): Is Finite
nv_is_nan() is.nan(<AnvlArray>): Is NaN
nv_is_infinite() is.infinite(<AnvlArray>): Is Infinite

Reduction Operations

Operations that reduce array axes

nv_sum() sum(<AnvlArray>): Sum Reduction
nv_prod() prod(<AnvlArray>): Product Reduction
nv_max() max(<AnvlArray>): Max Reduction
nv_min() min(<AnvlArray>): Min Reduction
nv_range() range(<AnvlArray>): Range Reduction
nv_any() any(<AnvlArray>): Any Reduction
nv_all() all(<AnvlArray>): All Reduction

Statistical Summaries

Summary statistics over array axes

nv_mean() mean(<AnvlArray>): Mean
nv_median() median(<AnvlArray>): Median
nv_quantile() quantile(<AnvlArray>): Quantile
nv_var(): Variance
nv_sd(): Standard Deviation

Cumulative Operations

Cumulative (scan) operations along a single axis

nv_cumsum() cumsum(<AnvlArray>): Cumulative Sum
nv_cumprod() cumprod(<AnvlArray>): Cumulative Product
nv_cummax() cummax(<AnvlArray>): Cumulative Maximum
nv_cummin() cummin(<AnvlArray>): Cumulative Minimum

Linear Algebra

Linear algebra operations

nv_matmul() `%*%`(<AnvlArray>): Matrix Multiplication
nv_chol() chol(<AnvlArray>): Cholesky Decomposition
nv_qr() qr(<AnvlArray>): QR Decomposition
nv_lu(): LU Decomposition
nv_svd(): Singular Value Decomposition
nv_eigh(): Symmetric Eigendecomposition
nv_solve() solve(<AnvlArray>): Solve Linear System
nv_triangular_solve(): Triangular Solve
nv_inv(): Matrix Inverse
nv_det(): Determinant
nv_determinant() determinant(<AnvlArray>): Determinant in Modulus/Sign Form
nv_crossprod() crossprod(<AnvlArray>): Cross Product (Matrix)
nv_tcrossprod() tcrossprod(<AnvlArray>): Transpose Cross Product (Matrix)
nv_outer(): Outer Product
nv_trace(): Matrix Trace
nv_extract_diag(): Extract Diagonal
nv_tril(): Lower Triangular Matrix
nv_triu(): Upper Triangular Matrix
nv_lower_tri() nv_lower_tri_like(): Lower Triangular Mask
nv_upper_tri() nv_upper_tri_like(): Upper Triangular Mask

Convolution

N-dimensional convolution operations

nv_conv1d(): 1D Convolution
nv_conv2d(): 2D Convolution
nv_conv3d(): 3D Convolution

Logical and Bitwise Operations

Logical and bitwise operations on arrays

nv_and() `&`(<AnvlArray>): Bitwise AND
nv_or() `|`(<AnvlArray>): Bitwise OR
nv_xor(): Bitwise XOR
nv_not() `!`(<AnvlArray>): Bitwise Not
nv_shift_left(): Shift Left
nv_shift_right_logical(): Logical Shift Right
nv_shift_right_arithmetic(): Arithmetic Shift Right
nv_popcnt(): Population Count

Element-wise Operations

Other element-wise array operations

nv_pmin(): Parallel Minimum
nv_pmax(): Parallel Maximum
nv_clamp(): Clamp

Sorting and Searching

Sorting arrays and finding extrema

nv_sort() sort(<AnvlArray>): Sort
nv_order(): Sort Order
nv_top_k(): Top-K Elements
nv_which_max(): Index of the Maximum
nv_which_min(): Index of the Minimum

Control Flow

Control flow operations

nv_if(): Conditional Branching
nv_while(): While Loop
nv_scan(): Scan (Loop with Per-Step Outputs)
nv_ifelse(): Conditional Element Selection

Distributions

Densities, distribution functions, and samplers for probability distributions

nv_dnorm() nv_pnorm() nv_qnorm() nv_rnorm(): The Normal Distribution
nv_dunif() nv_punif() nv_qunif() nv_runif(): The Uniform Distribution
nv_dbinom() nv_pbinom() nv_qbinom(): The Binomial Distribution
nv_dpois() nv_ppois() nv_qpois(): The Poisson Distribution
nv_dexp() nv_pexp() nv_qexp(): The Exponential Distribution
nv_rbinom(): Sample from a Binomial Distribution
nv_sample(): Sample from a Population
nv_sample_int(): Sample Integers

Random Numbers

Seeding, saving and restoring the global random state the samplers draw from

nv_set_seed() nv_get_rng_state() nv_set_rng_state() local_nv_seed() with_nv_seed(): Set the Global Random State
nv_rng_state(): Create a Random State
local_nv_rng_state() with_nv_rng_state(): Draw From a Random State for a Scope

Utilities

Helpers supporting the API functions

nv_print(): Print Array

Data Types and Promotion

Data types, their defaults, and the rules for promoting inputs to a common one

Data Types

dtype_categories: Data Type Categories
as_dtype(): Convert to a DataType
is_dtype(): Check If an Object Is a DataType
common_dtype(): Common Data Type
peek_dtype(): Peek at a Data Type
default_dtypes() default_float() default_int(): Default Data Types
local_default_dtypes() with_default_dtypes(): Set the Default Data Types
with_dtypes(): Run a Function at Given Data Types

Promotion Rules

How nv_* functions promote their inputs; see the Data Types and Promotion Rules article for how they are used.

nv_promote_to_common(): Promote Arrays to a Common Data Type
apply_promotion(): Bring a Primitive's Operands to One Data Type
promotion_common() promotion_like() promotion_dtype() promotion_rdata_common() promotion_grouped() promotion_rule(): Promotion Rules

Transformations

Code transformations

jit(): JIT Compile a Function
gradient() value_and_gradient(): Gradients

Backend

Backend-related functionality and implementations

backend(): Get Backend Name of an Array
local_backend() with_backend(): Temporarily Set the Backend
AnvlBackendPjrt(): PJRT Backend
AnvlBackendQuickr(): Quickr Backend

Device

Devices of the active backend and the default device

nv_device(): Create a Device
default_device(): Get the Default Device
local_default_device() with_default_device(): Temporarily Set the Default Device
is_device(): Test Whether an Object Is a Device
quickr_device(): Quickr Device

Miscellaneous

General-purpose helpers

arr(): Create an R Array
eq_type() neq_type(): Compare AbstractArray Types
map_tree() pmap_tree(): Map a Function over Trees

Internals

Internal data structures and functions

Graph

AnvlGraph(): Graph of Statements
GraphDescriptor(): Graph Descriptor
GraphNode: Graph Node
GraphValue(): Graph Value
GraphBox(): Graph Box
GraphLiteral(): Graph Literal
GraphStatement(): Graph Statement
local_descriptor(): Create a Graph
current_descriptor(): Get the Current Graph
subgraphs(): Get Subgraphs from Higher-Order Primitive

Abstract Types

nv_aval() AbstractArray(): Abstract Array Class
ConcreteArray(): Concrete Array Class
LiteralArray(): Literal Array Class
RData(): R Data Class
IotaArray(): Iota Array Class
to_abstract(): Convert to Abstract Array
is_arrayish(): Array-Like Objects

Transformations

trace_fn(): Trace an R Function into a Graph
graph_gradient(): Transform a Graph to Its Gradient
graph_to_quickr_r_function(): Convert an AnvlGraph to a Plain R Function
compile_pjrt(): Trace, Lower, and Compile a Function to an XLA Executable
stablehlo(): Lower a Graph to StableHLO
current_platform() local_platform(): Current Lowering Target Platform

Tree

Utilities for working with nested structures

reexports flatten build_tree unflatten tree_size tree_path: Objects exported from other packages

Miscellaneous

AnvlBackend(): Create a Backend
active_backend(): Get Active Backend
jit_cache_size(): Number of Cached Programs of a Jitted Function
Shape(): Create a Shape Object

Primitives

Low-level primitive operations (prim_* functions)

Construction

new_primitive(): Create a Primitive
AnvlPrimitiveDef(): Primitive Definition
graph_desc_add(): Add a Statement to a Graph Descriptor
rule_reverse(): Reverse Rule

Implemented Primitives

prim_abs(): Primitive Absolute Value
prim_acos(): Primitive Arc Cosine
prim_acosh(): Primitive Inverse Hyperbolic Cosine
prim_add(): Primitive Addition
prim_all(): Primitive All Reduction
prim_and(): Primitive Bitwise And
prim_any(): Primitive Any Reduction
prim_asin(): Primitive Arc Sine
prim_asinh(): Primitive Inverse Hyperbolic Sine
prim_atan(): Primitive Arc Tangent
prim_atan2(): Primitive Arctangent 2
prim_atanh(): Primitive Inverse Hyperbolic Tangent
prim_bitcast_convert(): Primitive Bitcast Conversion
prim_broadcast_in_axes(): Primitive Broadcast
prim_cbrt(): Primitive Cube Root
prim_ceiling(): Primitive Ceiling
prim_chol(): Primitive Cholesky Decomposition
prim_clamp(): Primitive Clamp
prim_concatenate(): Primitive Concatenate
prim_convert(): Primitive Convert Data Type
prim_convolution(): Primitive Convolution
prim_cos(): Primitive Cosine
prim_cosh(): Primitive Hyperbolic Cosine
prim_cummax(): Primitive Cumulative Maximum
prim_cummin(): Primitive Cumulative Minimum
prim_cumprod(): Primitive Cumulative Product
prim_cumsum(): Primitive Cumulative Sum
prim_custom_gradient(): Primitive Custom Gradient
prim_digamma(): Primitive Digamma
prim_div(): Primitive Division
prim_dot_general(): Primitive Dot General
prim_dynamic_slice(): Primitive Dynamic Slice
prim_dynamic_update_slice(): Primitive Dynamic Update Slice
prim_eigh(): Primitive Symmetric Eigendecomposition
prim_eq(): Primitive Equal
prim_erf(): Primitive Error Function
prim_erf_inv(): Primitive Inverse Error Function
prim_erfc(): Primitive Complementary Error Function
prim_exp(): Primitive Exponential
prim_expm1(): Primitive Exponential Minus One
prim_fill(): Primitive Fill
prim_floor(): Primitive Floor
prim_gather(): Primitive Gather
prim_ge(): Primitive Greater Than or Equal
prim_gt(): Primitive Greater Than
prim_if(): Primitive If
prim_ifelse(): Primitive Ifelse
prim_iota(): Primitive Iota
prim_is_finite(): Primitive Is Finite
prim_le(): Primitive Less Than or Equal
prim_lgamma(): Primitive Log-Gamma
prim_log(): Primitive Logarithm
prim_log1p(): Primitive Log Plus One
prim_lt(): Primitive Less Than
prim_lu(): Primitive LU Decomposition
prim_max(): Primitive Max Reduction
prim_min(): Primitive Min Reduction
prim_mul(): Primitive Multiplication
prim_ne(): Primitive Not Equal
prim_negate(): Primitive Negation
prim_not(): Primitive Bitwise Not
prim_or(): Primitive Bitwise Or
prim_pad(): Primitive Pad
prim_plogis(): Primitive Logistic (Sigmoid)
prim_pmax(): Primitive Parallel Maximum
prim_pmin(): Primitive Parallel Minimum
prim_popcnt(): Primitive Population Count
prim_pow(): Primitive Power
prim_print(): Primitive Print
prim_prod(): Primitive Product Reduction
prim_psigamma(): Primitive Psigamma
prim_qr(): Primitive QR Decomposition
prim_reduce(): Primitive Generic Reduce
prim_remainder(): Primitive Remainder
prim_reshape(): Primitive Reshape
prim_rev(): Primitive Reverse
prim_round(): Primitive Round
prim_rsqrt(): Primitive Reciprocal Square Root
prim_sample_bits(): Primitive Random Bits
prim_scan(): Primitive Scan
prim_scatter(): Primitive Scatter
prim_shift_left(): Primitive Shift Left
prim_shift_right_arithmetic(): Primitive Arithmetic Shift Right
prim_shift_right_logical(): Primitive Logical Shift Right
prim_sign(): Primitive Sign
prim_sin(): Primitive Sine
prim_sinh(): Primitive Hyperbolic Sine
prim_sort(): Primitive Sort
prim_sqrt(): Primitive Square Root
prim_static_slice(): Primitive Static Slice
prim_sub(): Primitive Subtraction
prim_sum(): Primitive Sum Reduction
prim_svd(): Primitive Singular Value Decomposition
prim_tan(): Primitive Tangent
prim_tanh(): Primitive Hyperbolic Tangent
prim_top_k(): Primitive Top-K
prim_transpose(): Primitive Transpose
prim_triangular_solve(): Primitive Triangular Solve
prim_which_max(): Primitive Index of the Maximum
prim_which_min(): Primitive Index of the Minimum
prim_while(): Primitive While Loop
prim_xor(): Primitive Bitwise Xor

Package

anvl anvl-package: anvl: Accelerated Array Computing and Automatic Differentiation
install_anvl(): Install What a Backend Needs to Run