Module prelude_dev Copy item path Source TensorCopyPolicy The policy of copying tensor. op_binary_arithmetic op_binary_common op_ternary_arithmetic op_ternary_common op_tri op_with_func vec A contiguous growable array type with heap-allocated contents, written
Vec<T>. duplicate Duplicates the given code and substitutes specific identifiers
for different code snippets in each duplicate. format Creates a String using interpolation of runtime expressions. impl_from_tuple_to_axes_index izip Create an iterator running multiple iterators in lockstep. rstsr_assert rstsr_assert_eq rstsr_errcode rstsr_error rstsr_invalid rstsr_pattern rstsr_raise s slice Generate slice with into support and optional parameters. tensor_from_nested Create a tensor from a nested array literal (for development purposes). vec Creates a Vec Box A pointer type that uniquely owns a heap allocation of type T. DataArc DataOwned DeviceCpuRayon This is base device for Parallel CPU device. DeviceCpuSerial DiagonalArgs Error IndexedIterAxesMut IndexedIterAxesView IndexedIterLayout IndexedIterVecMut IndexedIterVecView IsCloseArgs Arguments for isclose function. IterAxesMut IterAxesView IterLayoutColMajor Layout iterator (column-major). IterLayoutRowMajor Layout iterator (row-major). IterVecMut IterVecView Layout Layout of tensor. LayoutMatMulConfig ParIterRSTSR PhantomData Zero-sized type used to mark things that “act like” they own a T. Range A (half-open) range bounded inclusively below and exclusively above
(start..end). RangeFrom A range only bounded inclusively below (start..). RangeFull An unbounded range (..). RangeInclusive A range bounded inclusively below and above (start..=end). RangeTo A range only bounded exclusively above (..end). RangeToInclusive A range only bounded inclusively above (..=end). Slice Slicing for python (numpy) convention; somehow similar to Rust’s range. Storage Stride String A UTF-8–encoded, growable string. TensorBase ThreadPool Represents a user-created thread pool . Vec A contiguous growable array type, written as Vec<T>, short for ‘vector’. Yeet Experimental Implement FromResidual<Yeet<T>> on your type to enable
do yeet expr syntax in functions returning your type. AxesIndex Enum for Axes indexing Bound An endpoint of a range of keys. BroadcastType ControlFlow Used to tell an operation whether it should exit early or go on as usual. DataCow DataMut DataRef DataReference FlagDiag FlagOrder The order of the tensor. FlagSide FlagSymm FlagTrans FlagUpLo Indexer IterLayout MatMulType Rules of matmul. RSTSRError TensorIterOrder The policy of the tensor iterator. TensorMutable Mutable tensor (either owned or mutable reference). CoroutineState Experimental The result of a coroutine resumption. OneSidedRangeBound Experimental An internal helper for split_off functions indicating
which end a OneSidedRange is bounded on. Add The addition operator +. AddAssign The addition assignment operator +=. ArangeAPI AsArrayAPI Trait for function asarray AsyncFn An async-aware version of the Fn AsyncFnMut An async-aware version of the FnMut AsyncFnOnce An async-aware version of the FnOnce BitAnd The bitwise AND operator &. BitAndAssign The bitwise AND assignment operator &=. BitOr The bitwise OR operator |. BitOrAssign The bitwise OR assignment operator |=. BitXor The bitwise XOR operator ^. BitXorAssign The bitwise XOR assignment operator ^=. ChangeableDefault ConcatAPI DTypeCastAPI DTypePromoteAPI DataAPI DataCloneAPI DataForceMutAPI DataIntoCowAPI DataMutAPI DataOwnedAPI Debug ? formatting.Deref Used for immutable dereferencing operations, like *v. DerefMut Used for mutable dereferencing operations, like in *v = 1;. DeviceAPI DeviceATan2API DeviceAbsAPI DeviceAcosAPI DeviceAcoshAPI DeviceAddAPI DeviceAddAssignAPI DeviceAsinAPI DeviceAsinhAPI DeviceAtanAPI DeviceAtanhAPI DeviceBaseAPI DeviceBitAndAPI DeviceBitAndAssignAPI DeviceBitOrAPI DeviceBitOrAssignAPI DeviceBitXorAPI DeviceBitXorAssignAPI DeviceCeilAPI DeviceChangeAPI DeviceComplexFloatAPI DeviceConjAPI DeviceCopySignAPI DeviceCosAPI DeviceCoshAPI DeviceCreationAnyAPI DeviceCreationComplexFloatAPI DeviceCreationNumAPI DeviceCreationPartialOrdNumAPI DeviceCreationTriAPI DeviceDivAPI DeviceDivAssignAPI DeviceEqualAPI DeviceExpAPI DeviceExpm1API DeviceFloorAPI DeviceFloorDivideAPI DeviceGEMMAPI DeviceGEMVAPI DeviceGreaterAPI DeviceGreaterEqualAPI DeviceHERKAPI DeviceHypotAPI DeviceImagAPI DeviceIndexSelectAPI DeviceInnerDotAPI DeviceInvAPI DeviceIsCloseAPI DeviceIsFiniteAPI DeviceIsInfAPI DeviceIsNanAPI DeviceLConsumeAddAPI DeviceLConsumeBitAndAPI DeviceLConsumeBitOrAPI DeviceLConsumeBitXorAPI DeviceLConsumeDivAPI DeviceLConsumeMulAPI DeviceLConsumeRemAPI DeviceLConsumeShlAPI DeviceLConsumeShrAPI DeviceLConsumeSubAPI DeviceLessAPI DeviceLessEqualAPI DeviceLog1pAPI DeviceLog2API DeviceLog10API DeviceLogAPI DeviceLogAddExpAPI DeviceMatMulAPI DeviceMaximumAPI DeviceMinimumAPI DeviceMulAPI DeviceMulAssignAPI DeviceNegAPI DeviceNextAfterAPI DeviceNotAPI DeviceNotEqualAPI DeviceNumAPI DeviceOpPackTriAPI DeviceOpUnpackTriAPI DeviceOp_MutA_API DeviceOp_MutA_NumB_API DeviceOp_MutA_RefB_API DeviceOp_MutC_NumA_RefB_API DeviceOp_MutC_RefA_NumB_API DeviceOp_MutC_RefA_RefB_API DevicePowAPI DeviceRConsumeAddAPI DeviceRConsumeBitAndAPI DeviceRConsumeBitOrAPI DeviceRConsumeBitXorAPI DeviceRConsumeDivAPI DeviceRConsumeMulAPI DeviceRConsumeRemAPI DeviceRConsumeShlAPI DeviceRConsumeShrAPI DeviceRConsumeSubAPI DeviceRawAPI DeviceRayonAPI DeviceRealAPI DeviceReciprocalAPI DeviceRemAPI DeviceRemAssignAPI DeviceRoundAPI DeviceSYMMAPI DeviceSYRKAPI DeviceShlAPI DeviceShlAssignAPI DeviceShrAPI DeviceShrAssignAPI DeviceSignAPI DeviceSignBitAPI DeviceSinAPI DeviceSinhAPI DeviceSqrtAPI DeviceSquareAPI DeviceStorageAPI DeviceSubAPI DeviceSubAssignAPI DeviceTanAPI DeviceTanhAPI DeviceTruncAPI DiagAPI DimAPI DimBaseAPI DimBroadcastableAPI DimDevAPI DimIntoAPI DimLayoutContigAPI DimShapeAPI DimStrideAPI Display Format trait for an empty format, {}. Div The division operator /. DivAssign The division assignment operator /=. Drop Custom code within the destructor. EmptyAPI EmptyLikeAPI ExtFloat Extension trait for float types (num::Float ExtNum ExtReal Extension trait for real types (floats and integers included). EyeAPI Fn The version of the call operator that takes an immutable receiver. FnMut The version of the call operator that takes a mutable receiver. FnOnce The version of the call operator that takes a by-value receiver. FromNestedArrayAPI FullAPI FullLikeAPI HStackAPI Index Used for indexing operations (container[index]) in immutable contexts. IndexMut Used for indexing operations (container[index]) in mutable contexts. IndexerDynamicAPI IndexerLargerOneAPI IndexerPreserveAPI IndexerSmallerOneAPI IntoRSTSR IterSplitAtAPI Itertools An Iterator LayoutMatMulAPI LinspaceAPI MeshgridAPI Mul The multiplication operator *. MulAssign The multiplication assignment operator *=. Neg The unary negation operator -. Not The unary logical negation operator !. OnesAPI OnesLikeAPI OpAllAPI OpAllCloseAPI OpAnyAPI OpArgMaxAPI OpArgMinAPI OpAssignAPI OpAssignArbitaryAPI OpCountNonZeroAPI OpL2NormAPI OpMaxAPI OpMeanAPI OpMinAPI OpProdAPI OpStdAPI OpSumAPI OpSumBoolAPI OpUnraveledArgMaxAPI OpUnraveledArgMinAPI OpVarAPI PackArrayAPI PackableArrayAPI RSTSRResultAPI RangeBounds RangeBounds is implemented by Rust’s built-in range types, produced
by range syntax like .., a.., ..b, ..=c, d..e, or f..=g.Rem The remainder operator %. RemAssign The remainder assignment operator %=. Shl The left shift operator <<. Note that because this trait is implemented
for all integer types with multiple right-hand-side types, Rust’s type
checker has special handling for _ << _, setting the result type for
integer operations to the type of the left-hand-side operand. This means
that though a << b and a.shl(b) are one and the same from an evaluation
standpoint, they are different when it comes to type inference. ShlAssign The left shift assignment operator <<=. Shr The right shift operator >>. Note that because this trait is implemented
for all integer types with multiple right-hand-side types, Rust’s type
checker has special handling for _ >> _, setting the result type for
integer operations to the type of the left-hand-side operand. This means
that though a >> b and a.shr(b) are one and the same from an evaluation
standpoint, they are different when it comes to type inference. ShrAssign The right shift assignment operator >>=. StackAPI Sub The subtraction operator -. SubAssign The subtraction assignment operator -=. TensorATan2API TensorAbsAPI TensorAcosAPI TensorAcoshAPI TensorAsinAPI TensorAsinhAPI TensorAtanAPI TensorAtanhAPI TensorBaseAPI TensorCeilAPI TensorChangeFromDevice TensorConjAPI TensorCopySignAPI TensorCosAPI TensorCoshAPI TensorDeviceChangeAPI TensorEqualAPI TensorExpAPI TensorExpm1API TensorFloorAPI TensorFloorDivideAPI TensorGreaterAPI TensorGreaterEqualAPI TensorHypotAPI TensorImagAPI TensorIntoOwnedAPI TensorInvAPI TensorIsFiniteAPI TensorIsInfAPI TensorIsNanAPI TensorLessAPI TensorLessEqualAPI TensorLog2API TensorLog10API TensorLogAPI TensorLogAddExpAPI TensorMaximumAPI TensorMinimumAPI TensorNotEqualAPI TensorPowAPI TensorRealAPI TensorRefAPI TensorRefMutAPI TensorRoundAPI TensorSignAPI TensorSignBitAPI TensorSinAPI TensorSinhAPI TensorSqrtAPI TensorSquareAPI TensorSumBoolAPI TensorTanAPI TensorTanhAPI TensorTruncAPI TensorViewAPI TensorViewMutAPI ToString A trait for converting a value to a String. TrilAPI TriuAPI UninitAPI UnpackArrayAPI UnstackAPI VStackAPI Write A trait for writing or formatting into Unicode-accepting buffers or streams. ZerosAPI ZerosLikeAPI CoerceShared Experimental Allows reborrowable value to be reborrowed as shared, creating a copy
that disables the source for writes for the lifetime of the copy. CoerceUnsized Experimental Trait that indicates that this is a pointer or a wrapper for one,
where unsizing can be performed on the pointee. Coroutine Experimental The trait implemented by builtin coroutine types. DerefPure Experimental Perma-unstable marker trait. Indicates that the type has a well-behaved DerefDerefMut DispatchFromDyn Experimental DispatchFromDyn is used in the implementation of dyn-compatibility checks (specifically
allowing arbitrary self types), to guarantee that a method’s receiver type can be dispatched on.FromResidual Experimental Used to specify which residuals can be converted into which crate::ops::Try IntoBounds Experimental Used to convert a range into start and end bounds, consuming the
range by value. OneSidedRange Experimental OneSidedRange is implemented for built-in range types that are unbounded
on one side. For example, a.., ..b and ..=c implement OneSidedRange,
but .., d..e, and f..=g do not.Reborrow Experimental Allows value to be reborrowed as exclusive, creating a copy of the value
that disables the source for reads and writes for the lifetime of the copy. Receiver Experimental Indicates that a struct can be used as a method receiver.
That is, a type can use this type as a type of self, like this: Residual Experimental Allows retrieving the canonical type implementing TryO as its output. Try Experimental The ? operator and try {} blocks. aligned_alloc Create an uninitialized vector with the given size and alignment. aligned_uninitialized_vec ⚠ Create an conditionally aligned uninitialized vector with the given size. allclose_f64 Compare two tensors with f64 data type. arange Evenly spaced values within the half-open interval [start, stop) as
one-dimensional array. arange_f asarray Convert the input to an array. asarray_f Convert the input to an array. assign_arbitary_cpu_rayon assign_arbitary_cpu_serial assign_arbitary_promote_cpu_rayon assign_arbitary_promote_cpu_serial assign_arbitary_uninit_cpu_rayon assign_arbitary_uninit_cpu_serial assign_arbitary_uninit_promote_cpu_rayon assign_arbitary_uninit_promote_cpu_serial assign_cpu_rayon assign_cpu_serial assign_promote_cpu_rayon assign_promote_cpu_serial assign_uninit_cpu_rayon assign_uninit_cpu_serial assign_uninit_promote_cpu_rayon assign_uninit_promote_cpu_serial assume_init ⚠ Converts a tensor with uninitialized values into a tensor with initialized values. assume_init_f ⚠ Converts a tensor with uninitialized values into a tensor with initialized values. broadcast_arrays Broadcasts any number of arrays against each other. broadcast_arrays_f Broadcasts any number of arrays against each other. broadcast_layout Layout broadcasting. broadcast_layout_to_first Layout broadcasting. broadcast_shape Shape broadcasting. broadcast_to Broadcasts an array to a specified shape. change_contig change_contig_f change_layout change_layout_f change_prefer change_prefer_f change_shape Reshapes the given tensor to the specified shape. change_shape_f Reshapes the given tensor to the specified shape. concat Join a sequence of arrays along an existing axis. concat_f concatenate Join a sequence of arrays along an existing axis. concatenate_f diag Extract a diagonal or construct a diagonal tensor. diag_f diagonal diagonal_f diagonal_mut diagonal_mut_f empty ⚠ Uninitialized tensor having a specified shape. empty_f ⚠ Safety empty_like ⚠ Uninitialized tensor with the same shape as an input tensor. empty_like_f ⚠ Safety expand_dims Expands the shape of an array by inserting a new axis (dimension) of size
one at the position specified by axis. expand_dims_f Expands the shape of an array by inserting a new axis (dimension) of size
one at the position specified by axis. eye Returns a two-dimensional array with ones on the kth diagonal and zeros
elsewhere. eye_f fill_cpu_rayon fill_cpu_serial fill_promote_cpu_rayon fill_promote_cpu_serial fingerprint Get a somehow unique fingerprint of a tensor. flip Reverses the order of elements in an array along the given axis. flip_f Reverses the order of elements in an array along the given axis. full New tensor having a specified shape and filled with given value. full_f full_like New tensor filled with given value and having the same shape as an input
tensor. full_like_f gemm_ix2_naive_cpu_rayon gemm_naive_cpu_serial gemv_naive_cpu_serial gevm_naive_cpu_serial greedy_layout This function will return a f-prefer layout that make minimal memory
accessing efforts (pointers will not frequently back-and-forth). hstack Stack tensors in sequence horizontally (column-wise). hstack_f index_select_cpu_rayon index_select_cpu_serial inner_dot_naive_cpu_rayon inner_dot_naive_cpu_serial inner_pack_tril_c_contig inner_pack_tril_general inner_pack_triu_c_contig inner_pack_triu_general inner_unpack_tril_c_contig inner_unpack_tril_general inner_unpack_triu_c_contig inner_unpack_triu_general into_broadcast Broadcasts an array to a specified shape. into_broadcast_f Broadcasts an array to a specified shape. into_contig into_contig_f into_diagonal into_diagonal_f into_diagonal_mut into_diagonal_mut_f into_dim Convert layout to the other dimension. into_dim_f Convert layout to the other dimension. into_dyn Convert layout to the dynamic dimension IxD into_expand_dims Expands the shape of an array by inserting a new axis (dimension) of size
one at the position specified by axis. into_expand_dims_f Expands the shape of an array by inserting a new axis (dimension) of size
one at the position specified by axis. into_flip Reverses the order of elements in an array along the given axis. into_flip_f Reverses the order of elements in an array along the given axis. into_layout into_layout_f into_permute_dims into_permute_dims_f into_prefer into_prefer_f into_reverse_axes into_shape Reshapes the given tensor to the specified shape. into_shape_assume_contig into_shape_assume_contig_f into_shape_f Reshapes the given tensor to the specified shape. into_slice into_slice_f into_squeeze into_squeeze_f into_swapaxes into_swapaxes_f into_transpose into_transpose_f layout_col_major_dim_dispatch_1 layout_col_major_dim_dispatch_2 layout_col_major_dim_dispatch_3 layout_col_major_dim_dispatch_2diff layout_col_major_dim_dispatch_par_1 layout_col_major_dim_dispatch_par_2 layout_col_major_dim_dispatch_par_3 layout_col_major_dim_dispatch_par_2diff layout_for_array_copy Return a layout that is suitable for array copy. layout_reshapeable Check if a tensor can be reshaped to a new shape without explicitly copying
underlying data. linspace Evenly spaced numbers over a specified interval. linspace_f matmul_naive_cpu_serial meshgrid Returns coordinate matrices from coordinate vectors. meshgrid_f normalize_axes_index Normalize axes argument into a tuple of non-negative integer axes. ones New tensor filled with ones and having a specified shape. ones_f ones_like New tensor filled with ones and having the same shape as an input
tensor. ones_like_f op_muta_func_cpu_rayon op_muta_func_cpu_serial op_muta_numb_func_cpu_rayon op_muta_numb_func_cpu_serial op_muta_refb_func_cpu_rayon op_muta_refb_func_cpu_serial op_mutc_numa_refb_func_cpu_rayon op_mutc_numa_refb_func_cpu_serial op_mutc_refa_numb_func_cpu_rayon op_mutc_refa_numb_func_cpu_serial op_mutc_refa_refb_func_cpu_rayon op_mutc_refa_refb_func_cpu_serial orderchange_out_c2r_ix2_cpu_rayon Change order (row/col-major) a matrix out-place using a naive algorithm. orderchange_out_c2r_ix2_cpu_serial Change order (row/col-major) a matrix out-place using a naive algorithm. orderchange_out_r2c_ix2_cpu_rayon Change order (row/col-major) a matrix out-place using a naive algorithm. orderchange_out_r2c_ix2_cpu_rayon_no_pool Change order (row/col-major) a matrix out-place using a naive algorithm. orderchange_out_r2c_ix2_cpu_serial Change order (row/col-major) a matrix out-place using a naive algorithm. pack_tri_cpu_rayon pack_tri_cpu_serial permute_dims Permutes the axes (dimensions) of an array x. permute_dims_f reduce_all_arg_cpu_rayon reduce_all_arg_cpu_serial reduce_all_binary_cpu_rayon reduce_all_binary_cpu_serial reduce_all_cpu_rayon reduce_all_cpu_serial reduce_all_unraveled_arg_cpu_rayon reduce_all_unraveled_arg_cpu_serial reduce_axes_arg_cpu_rayon reduce_axes_arg_cpu_serial reduce_axes_cpu_rayon reduce_axes_cpu_serial reduce_axes_difftype_cpu_rayon reduce_axes_difftype_cpu_serial reduce_axes_unraveled_arg_cpu_rayon reduce_axes_unraveled_arg_cpu_serial reshape Reshapes the given tensor to the specified shape. reshape_assume_contig Assuming contiguous array, reshapes an array without changing its data. reshape_assume_contig_f reshape_f Reshapes the given tensor to the specified shape. reshape_substitute_negatives Check -1 in shape and substitute it with the correct value. reverse_axes Reverse the order of elements in an array along the given axis. reversed_permute Reversed permutation indices. rstsr_backtrace slice slice_f slice_mut slice_mut_f squeeze Removes singleton dimensions (axes) from x. squeeze_f stack Joins a sequence of arrays along a new axis. stack_f swapaxes Interchange two axes of an array. swapaxes_f to_broadcast Broadcasts an array to a specified shape. to_broadcast_f Broadcasts an array to a specified shape. to_contig to_contig_f to_dim Convert layout to the other dimension. to_dim_f Convert layout to the other dimension. to_dyn Convert layout to the dynamic dimension IxD to_layout Convert tensor to the other layout. to_layout_f to_prefer to_prefer_f to_shape Reshapes the given tensor to the specified shape. to_shape_assume_contig Assuming contiguous array, reshapes an array without changing its data. to_shape_assume_contig_f to_shape_f Reshapes the given tensor to the specified shape. translate_to_col_major Translate multiple layouts to column-major iteration. translate_to_col_major_unary Translate one layout to column-major iteration. translate_to_col_major_with_contig This function will return minimal dimension layout, that the first axis is
f-contiguous. transpose Permutes the axes (dimensions) of an array x. transpose_f tril Returns the lower triangular part of a matrix (or a stack of matrices) x. tril_cpu_serial tril_f tril_ix2_cpu_serial triu Returns the upper triangular part of a matrix (or a stack of matrices) x. triu_cpu_serial triu_f triu_ix2_cpu_serial unaligned_uninitialized_vec ⚠ Create an unaligned uninitialized vector with the given size. uninit New tensor filled with uninitialized values and having a specified shape. uninit_f uninitialized_vec ⚠ Create an uninitialized vector with the given size. unpack_tri_cpu_rayon unpack_tri_cpu_serial unrolled_binary_reduce Fold over the manually unrolled xs1 and xs2 (binary inputs) with f. unrolled_reduce Fold over the manually unrolled xs with f. unstack Splits an array into a sequence of arrays along the given axis. unstack_f update_layout_by_shape vstack Stack tensors in sequence horizontally (row-wise). vstack_f zeros New tensor filled with zeros and having a specified shape. zeros_f zeros_like New tensor filled with zeros and having the same shape as an input
tensor. zeros_like_f DeviceCpu Ix Fixed size dimension. Ix0 Ix1 Ix2 Ix3 Ix4 Ix5 Ix6 Ix7 Ix8 Ix9 IxD IxDyn Dynamic size dimension. Result SliceI In most cases, we will use isize for indexing. Tensor TensorAny TensorArc TensorCow TensorDiag TensorMut TensorOrder TensorRef TensorReference TensorSide TensorSymm TensorTrans TensorUpLo TensorView TensorViewMut MaybeUninit A wrapper type to construct uninitialized instances of T. duplicate_item Duplicates the item and substitutes specific identifiers for different code
snippets in each duplicate. substitute_item Substitutes specific identifiers for different code
snippets. Debug Derive macro generating an impl of the trait Debug.