Kernel Operations on GPU or CPU, with Autodiff, without Memory Overflows

Documentation for package ‘rkeops’ version 2.2.2

Help Pages

A B C D E G I K L M N O P R S T U V W X misc

rkeops

-- A --

abs	Element-wise absolute value (or modulus) operation
abs.ComplexLazyTensor	Element-wise absolute value operation
abs.default	Miscellaneous Mathematical Functions
abs.LazyTensor	Element-wise absolute value operation
acos	Element-wise arc-cosine operation.
acos.default	Trigonometric Functions
acos.LazyTensor	Element-wise arc-cosine operation
Arg	Element-wise argument (or angle) of complex operation
Arg.ComplexLazyTensor	Element-wise argument (or angle) of complex
Arg.default	Complex Numbers and Basic Functionality
Arg.LazyTensor	Element-wise argument (or angle) of complex
argKmin	Arg-K-min reduction
argKmin_reduction	Arg-K-min reduction
argmax	ArgMax operation or ArgMax reduction
argmax_reduction	ArgMax operation or ArgMax reduction
argmin	ArgMin operation or ArgMin reduction
argmin_reduction	ArgMin operation or ArgMin reduction
arithmetic.add	Addition
arithmetic.add.LazyTensor	Addition
arithmetic.divide	Division
arithmetic.divide.LazyTensor	Division
arithmetic.multiply	Multiplication
arithmetic.multiply.LazyTensor	Multiplication
arithmetic.power	Element-wise power operation
arithmetic.power.LazyTensor	Element-wise power operation
arithmetic.subtract	Subtraction or minus sign
arithmetic.subtract.LazyTensor	Subtraction or minus sign
asin	Element-wise arc-sine operation.
asin.default	Trigonometric Functions
asin.LazyTensor	Element-wise arc-sine operation
atan	Element-wise arc-tangent operation.
atan.default	Trigonometric Functions
atan.LazyTensor	Element-wise arc-tangent operation
atan2	Element-wise 2-argument arc-tangent operation.
atan2.default	Trigonometric Functions
atan2.LazyTensor	Element-wise 2-argument arc-tangent operation

-- B --

binaryop.LazyTensor

Build a binary operation

-- C --

check_rkeops	Check if 'rkeops' is ready and working
clamp	Element-wise clamp function
clampint	Element-wise clampint function
clean_rkeops	Clean RKeOps build directory
complex.default	Complex Numbers and Basic Functionality
concat	Concatenation
Conj	Element-wise complex conjugate operation
Conj.ComplexLazyTensor	Element-wise complex conjugate
Conj.default	Complex Numbers and Basic Functionality
Conj.LazyTensor	Element-wise complex conjugate
cos	Element-wise cosine operation.
cos.default	Trigonometric Functions
cos.LazyTensor	Element-wise cosine operation

-- D --

default.arithmetic.fun	Default arithmetic operations
default.log.exp.fun	Logarithms and Exponentials
default.math.fun	Miscellaneous Mathematical Functions
default.trigo.fun	Trigonometric Functions

-- E --

elem	Extract an element
elemT	Insert element in a vector of zeros
exp	Element-wise exponential operation
exp.ComplexLazyTensor	Element-wise exponential operation
exp.default	Logarithms and Exponentials
exp.LazyTensor	Element-wise exponential operation
exp1j	Element-wise "complex exponential of 1j x" operation.
exp1j.ComplexLazyTensor	Element-wise "complex exponential of 1j x" operation.
exp1j.LazyTensor	Element-wise "complex exponential of 1j x" operation.
extract	Extract a range of elements
extractT	Insert a range of elements

-- G --

get_rkeops_build_dir	Get RKeOps build directory
get_rkeops_options	Get the current 'rkeops' options in 'R' global options scope
grad	Gradient operation.

-- I --

ifelse	Element-wise if-else function
ifelse.default	Conditional Element Selection
ifelse.LazyTensor	Element-wise if-else function.
Im	Element-wise complex imaginery part operation
Im.ComplexLazyTensor	Element-wise complex imaginery part
Im.default	Complex Numbers and Basic Functionality
Im.LazyTensor	Element-wise complex imaginery part
imag2complex	Element-wise "imaginary to complex" operation.
imag2complex.ComplexLazyTensor	Element-wise "imaginary to complex" operation.
imag2complex.LazyTensor	Element-wise "imaginary to complex" operation.
imaginary2complex	Element-wise "imaginary to complex" operation.
install_rkeops	Install RKeOps requirements
inv	Element-wise inverse operation.
inv.default	Element-wise inverse operation
inv.LazyTensor	Element-wise inverse operation
is.ComplexLazyParameter	is.ComplexLazyParameter?
is.ComplexLazyTensor	is.ComplexLazyTensor?
is.int	Scalar integer test.
is.LazyMatrix	is.LazyMatrix?
is.LazyParameter	is.LazyParameter?
is.LazyTensor	is.LazyTensor?
is.LazyVector	is.LazyVector?

-- K --

keops_grad	Compute the gradient of a rkeops operator
keops_kernel	Defines a new KeOps operator to compute a specific symbolic formula
Kmin	K-Min reduction
Kmin_argKmin	K-Min-arg-K-min reduction
Kmin_argKmin_reduction	K-Min-arg-K-min reduction
Kmin_reduction	K-Min reduction

-- L --

LazyTensor	Build and return a LazyTensor object.
log	Element-wise natural logarithm operation
log.default	Logarithms and Exponentials
log.LazyTensor	Element-wise natural logarithm operation
logical	Logical.or
logsumexp	Log-Sum-Exp reduction.
logsumexp_reduction	Log-Sum-Exp reduction.
ls_rkeops_build_dir	List RKeOps build directory content

-- M --

matmult	Matrix multiplication
matmult.default	Matrix multiplication
matmult.LazyTensor	Matrix multiplication
matvecmult	Matrix-vector product
max	Maximum operation or maximum reduction
max.default	Maximum operation
max.LazyTensor	Maximum operation or maximum reduction
max_argmax	Max-ArgMax reduction
max_argmax_reduction	Max-ArgMax reduction
max_reduction	Maximum operation or maximum reduction
min	Minimum operation or minimum reduction
min.default	Minimum operation
min.LazyTensor	Minimum operation or minimum reduction
min_argmin	Min-ArgMin reduction
min_argmin_reduction	Min-ArgMin reduction
min_reduction	Minimum operation or minimum reduction
Mod	Element-wise complex modulus (absolute value) operation
mod	Element-wise modulo with offset function
Mod.ComplexLazyTensor	Element-wise complex modulus (absolute value)
Mod.default	Complex Numbers and Basic Functionality
Mod.LazyTensor	Element-wise complex modulus (absolute value)
mod.LazyTensor	Element-wise modulo with offset function

-- N --

norm2	Euclidean norm
normalize	Vector normalization

-- O --

one_hot

One-hot encoding vector

-- P --

Pm	Wrapper LazyTensor parameter.

-- R --

Re	Element-wise complex real part operation
Re.ComplexLazyTensor	Element-wise complex real part
Re.default	Complex Numbers and Basic Functionality
Re.LazyTensor	Element-wise complex real part
real2complex	Element-wise "real to complex" operation.
real2complex.ComplexLazyTensor	Element-wise "real to complex" operation.
real2complex.LazyTensor	Element-wise "real to complex" operation.
reduction.LazyTensor	Reduction operation
relu	Element-wise ReLU function
relu.default	Element-wise ReLU function
relu.LazyTensor	Element-wise ReLU function
rkeops	rkeops
rkeops_disable_verbosity	Disable additional verbosity in 'rkeops'
rkeops_enable_verbosity	Enable additional verbosity in 'rkeops'
rkeops_use_cpu	Enable GPU-computing when calling user-defined operators
rkeops_use_float32	Use 32bit float precision in computations
rkeops_use_float64	Use 64bit float precision in computations
rkeops_use_gpu	Enable GPU-computing when calling user-defined operators
round	Element-wise rounding function
round.default	Rounding function
round.LazyTensor	Element-wise rounding function
rsqrt	Element-wise inverse square root operation
rsqrt.default	Element-wise inverse square root operation
rsqrt.LazyTensor	Element-wise inverse square root operation

-- S --

scalar.product.LazyTensor	Euclidean scalar product operation
ScalarProduct.or.OR	Euclidean scalar product (for LazyTensors) or default logical "or"
set_rkeops_options	Initialize or update 'rkeops' options in 'R' global options scope
sign	Element-wise sign operation
sign.default	Sign function
sign.LazyTensor	Element-wise sign operation
sin	Element-wise sine operation.
sin.default	Trigonometric Functions
sin.LazyTensor	Element-wise sine operation
sinxdivx	Element-wise 'sin(x)/x' function
sinxdivx.default	sin(x)/x function
sinxdivx.LazyTensor	Element-wise 'sin(x)/x' operation
sqdist	Squared distance
sqnorm2	Squared Euclidean norm
sqrt	Element-wise square root operation
sqrt.default	Miscellaneous Mathematical Functions
sqrt.LazyTensor	Element-wise square root operation
square	Element-wise square (power-2) operation
square.default	Element-wise square (power-2) operation
square.LazyTensor	Element-wise square (power-2) operation
step	Element-wise 0-1 step function (for LazyTensors) or default stepwise model selection
step.default	Choose a model by AIC in a Stepwise Algorithm
step.LazyTensor	Element-wise 0-1 step function
sum	Sum operation or sum reduction
sum.default	Sum operation
sum.LazyTensor	Sum operation or sum reduction
sumsoftmaxweight	Sum of weighted Soft-Max reduction.
sumsoftmaxweight_reduction	Sum of weighted Soft-Max reduction.
sum_reduction	Sum operation or sum reduction

-- T --

tensorprod	Tensor product
ternaryop.LazyTensor	Build a ternary operation

-- U --

unaryop.LazyTensor

Build a unary operation

-- V --

vecmatmult	Vector-matrix product
Vi	Wrapper LazyTensor indexed by "i".
Vj	Wrapper LazyTensor indexed by "j".

-- W --

weightedsqdist	Generic weighted squared distance
weightedsqnorm	Generic weighted squared Euclidean norm

-- X --

xlogx	Element-wise 'x*log(x)' operation
xlogx.default	x*log(x) function
xlogx.LazyTensor	Element-wise 'x*log(x)' operation

-- misc --

%*%	Matrix multiplication
%*%.default	Matrix multiplication
%*%.LazyTensor	Matrix multiplication
*	Multiplication
*.ComplexLazyTensor	Multiplication
*.default	Default arithmetic operations
*.LazyTensor	Multiplication
+	Addition
+.ComplexLazyTensor	Addition
+.default	Default arithmetic operations
+.LazyTensor	Addition
-	Subtraction or minus sign
-.ComplexLazyTensor	Subtraction or minus sign
-.default	Default arithmetic operations
-.LazyTensor	Subtraction or minus sign
/	Division
/.ComplexLazyTensor	Division
/.default	Default arithmetic operations
/.LazyTensor	Division
^	Element-wise power operation
^.default	Default arithmetic operations
^.LazyTensor	Element-wise power operation
^.lazyTensor	Element-wise power operation
\|	Euclidean scalar product (for LazyTensors) or default logical "or"
\|.default	Logical.or
\|.LazyTensor	Euclidean scalar product operation