Documentation

The reference documentation


Descriptive Statistics

Descriptive Statistics


Functions:

asum

Computes the sum of the absolute value of the elements of a data range.

asum2

Computes the sum of the squared absolute value of the elements of a data range.

excess kurtosis

Computes the population kurtosis excess of the elements of a data range.

excess kurtosis (sampled)

Computes the population kurtosis excess of the elements of a data range.

filtered_mean

Computes the filtered mean (or average) of the elements of a data range.

filtered_sum

Computes the filtered sum of the elements of a data range.

invalid_count

Computes the number of the elements of a data range which are not representing valid numbers.

invalid_ratio

Computes the percentage of elements of a data range which are not representing valid numbers.

kurtosis

Computes the population kurtosis of the elements of a data range.

kurtosis (sampled)

Computes the bias-corrected kurtosis of the elements of a data range.

maximum

Computes the maximum of the elements of a data range.

mean

Computes the mean (or average) of the elements of a data range.

median

Computes the median of the elements of a data range.

minimum

Computes the minimum of the elements of a data range.

skewness

Computes the population skewness of the elements of a data range.

skewness (sampled)

Computes the bias-corrected skewness of the elements of a data range.

spread

Computes the spread of the elements of a data range.

standard deviation

Computes the population standard deviation of the elements of a data range.

standard deviation (sampled)

Computes the bias-corrected standard deviation of the elements of a data range.

sum

Computes the sum of the elements of a data range.

variance

Computes the population variance of the elements of a data range.

variance (sampled)

Computes the bias-corrected variance of the elements of a data range.

weighted mean

Computes the weighted mean (or average) of the elements of a data range.

weighted sum

Computes the weighted sum of the elements of a data range.

Fast-Fourier Transform

Fast-Fourier Transform


Functions:

forward_transform_power_of_2

This function calculates a forward Fourrier transform of the input data. The results from the transform are stored in-order in...

forward_transform_power_of_2_2d

This function calculates a 2D forward Fourrier transform of the input data. The results from the transform are stored in-order...

forward_transform_power_of_2_3d

This function calculates a 3D forward Fourrier transform of the input data. The results from the transform are stored in-order...

inverse_transform_power_of_2

This function calculates an inverse Fourrier transform of the input data. Archr-R FFT computes an unnormalized transform meaning that if...

inverse_transform_power_of_2_2d

This function calculates an 2D inverse Fourrier transform of the input data. Archr-R FFT computes an unnormalized transform meaning that...

inverse_transform_power_of_2_3d

This function calculates a 3D inverse Fourrier transform of the input data. The results from the transform are stored in-order...

planner

The first step in using Arch-R FFT is to create a plan. A plan is an object containing all of...

Linear Algebra

Linear Algebra


Functions:

axpy

Apply the AXPY kernel.

conjugate_dot

Computes the conjugate dot product between the elements of two data ranges.

copy

Copy the data of one range into another.

dot

Computes the dot product between the elements of two data ranges.

gemv (small)

Highly optimized GEMV for small matrices

norm2

Computes the norm2 of a given data range.

rotg

Compute a rotation matrix from a specified 2D point.

scale

Apply a scaling factor to all elements in a data range.

strided_axpy

Apply the AXPY kernel over strided data ranges.

strided_conjugate_dot

Computes the conjugate dot product between the elements of two strided data ranges.

strided_copy

Copy the data of one strided range into another.

strided_dot

Computes the norm2 of a given strided data range.

strided_norm2

Computes the norm2 product between the elements of two strided data ranges.

strided_scale

Apply a scaling factor to all elements in a strided data range.

strided_swap

Swap data between two strided ranges.

swap

Swap data between two ranges.

Memory Custom Handlers

Memory Custom Handlers


Functions:

set_align_memory_functions

Replace the current aligned allocation functions from the arguments. These functions will be used for all memory allocation done by...

set_memory_functions

Replace the current allocation functions from the arguments. These functions will be used for all memory allocation done by Arch-R....

Core Functions

Core functions


Functions:

abs

Computes the Absolute Value.

acos

Computes the Inverse Cosine.

acosd

Computes the Inverse Cosine in Degree.

acosh

Computes the Inverse Hyperbolic Cosine.

acospi

Computes the Inverse Cosine in multiple of PIs.

acot

Computes the Inverse Cotangent in Radians.

acotd

Computes the Inverse Cotangent in Degrees.

acoth

Computes the Inverse Hyperbolic Cotangent.

acotpi

Computes the Inverse Hyperbolic in multiple of PIs.

acsc

Computes the Inverse Cosecant in Radians.

acscd

Computes the Inverse Cosecant in Degrees.

acsch

Computes the Inverse Hyperbolic Cosecant.

acscpi

Computes the Inverse Cosecant in multiple of PIs.

asec

Computes the Inverse Secant in Radians.

asecd

Computes the Inverse Second in Degrees.

asech

Computes the Inverse Hyperbolic Secant.

asecpi

Computes the Inverse Secant in multiple of PIs.

asin

Computes the Inverse Sine in Radians.

asind

Computes the Inverse Sine in Degrees.

asinh

Computes the Inverse Hyperbolic Sine.

asinpi

Computes the Inverse Sine in multiple of PIs.

atan

Computes the Inverse Tangent in Radians.

atan2

Computes the Four-Quadrant Inverse Tangent in Radians.

atan2d

Computes the Four-Quadrant Inverse Tangent in Degrees.

atan2pi

Computes the Four-Quadrant Inverse Tangent in multiple of PIs.

atand

Computes the Four-Quadrant Inverse Tangent in Degrees.

atanh

Computes the Four-Quadrant Hyperbolic Inverse Tangent.

atanpi

Computes the Four-Quadrant Inverse Tangent in multiple of PIs.

average

Computes the Average between two elements.

bitfloating

Computes the bitfloating.

bitofsign

Computes the bitofsign.

bits

Computes the bits.

bitwise_and

Computes the bitwise_and.

bitwise_andnot

Computes the bitwise_andnot.

bitwise_not

Computes the bitwise_not.

bitwise_notand

Computes the bitwise_notand.

bitwise_notor

Computes the bitwise_notor.

bitwise_or

Computes the bitwise_or.

bitwise_ornot

Computes the bitwise_ornot.

bitwise_select

Computes the bitwise_select.

bitwise_xor

Computes the bitwise_xor.

cbrt

Computes the Cubic Root.

ceil

Computes the nearest greater or equal rounded Value.

clz

Computes the the number of leading Zeros of its input.

complement

Computes the Complement.

conj

Computes the Conjugate.

copysign

Computes the the value x with the sign of y.

cos

Computes the Cosine in Radians.

cosd

Computes the Cosine in Degrees.

cosh

Computes the Hyperbolic Cosine.

cospi

Computes the Cosine in multiple of PIs.

cot

Computes the Cotangent in Radians.

cotd

Computes the Cosine in Degrees.

coth

Computes the Hyperbolic Cosine.

cotpi

Computes the Cosine in multiple of PIs.

csc

Computes the Cosecant in Radians.

cscd

Computes the Cosecant in Degrees.

csch

Computes the Hyperbolic Cosecant.

cscpi

Computes the Cosecant in multiple of PIs.

ctz

Computes the the number of trailling Zeros of its input.

dec

Computes the Decrement.

dist

Computes the the absolute value of the differents of its inputs.

div

Computes the div.

divides

Computes the Quotient of its inputs.

eps

Computes the Epsilon.

erf

Computes the the error function.

erfc

Computes the Complementary Error Function.

erfcx

Computes the Underflow-Compensating (Scaled) Complementary error function.

exp

Computes the exp.

exp10

Computes the Base-Ten Exponential.

exp2

Computes the Base-Two Exponential.

expm1

Computes the Exponential minus 1.

exponent

Computes the exponent of its input.

exponentbits

Computes the exponentbits.

exprecneg

Computes the exprecneg.

exprecnegc

Computes the \(1-e^{-\frac1x}\):

  • to the range defined by:

    • [i1_first, i1_last)
    • [i1, i1 + sz)

    and stores the...

expx2

Computes the expx2.

ffs

Computes the ffs.

firstbitset

Computes the firstbitset.

firstbitunset

Computes the firstbitunset.

fix

Computes the fix.

floor

Computes the floor.

fma

Computes the fma.

fms

Computes the fms.

fnma

Computes the fnma.

fnms

Computes the fnms.

fpclassify

Computes the fpclassify.

frac

Computes the frac.

gamma

Computes the gamma.

gammaln

Computes the gammaln.

hi

Computes the hi.

hypot

Computes the hypot.

i1

Computes the Argument (Angular Orientation).

iceil

Computes the iceil.

if_allbits_else

Computes the if_allbits_else.

if_allbits_else_zero

Computes the if_allbits_else_zero.

if_dec

Computes the if_dec.

if_else

Computes the if_else.

if_else_allbits

Computes the if_else_allbits.

if_else_nan

Computes the if_else_nan.

if_else_zero

Computes the if_else_zero.

if_inc

Computes the if_inc.

if_nan_else

Computes the if_nan_else.

if_one_else_zero

Computes the if_one_else_zero.

if_plus

Computes the if_plus.

if_zero_else

Computes the if_zero_else.

if_zero_else_allbits

Computes the if_zero_else_allbits.

if_zero_else_one

Computes the if_zero_else_one.

ifix

Computes the ifix.

ifloor

Computes the ifloor.

ifnot_dec

Computes the ifnot_dec.

ifnot_inc

Computes the ifnot_inc.

ifnot_minus

Computes the ifnot_minus.

ifnot_plus

Computes the ifnot_plus.

ilog2

Computes the ilog2.

ilogb

Computes the ilogb.

inc

Computes the inc.

indeg

Computes the indeg.

inearbyint

Computes the inearbyint.

inrad

Computes the inrad.

iround

Computes the iround.

is_denormal

Computes the is_denormal.

is_equal

Computes the is_equal.

is_equal_with_equal_nans

Computes the is_equal_with_equal_nans.

is_eqz

Computes the is_eqz.

is_even

Computes the is_even.

is_finite

Computes the is_finite.

is_flint

Computes the is_flint.

is_gez

Computes the is_gez.

is_greater

Computes the is_greater.

is_greater_equal

Computes the is_greater_equal.

is_gtz

Computes the is_gtz.

is_imag

Computes the is_imag.

is_inf

Computes the is_inf.

is_invalid

Computes the is_invalid.

is_less

Computes the is_less.

is_less_equal

Computes the is_less_equal.

is_lessgreater

Computes the is_lessgreater.

is_lez

Computes the is_lez.

is_ltz

Computes the is_ltz.

is_nan

Computes the is_nan.

is_negative

Computes the is_negative.

is_nez

Computes the is_nez.

is_ngez

Computes the is_ngez.

is_ngtz

Computes the is_ngtz.

is_nlez

Computes the is_nlez.

is_nltz

Computes the is_nltz.

is_normal

Computes the is_normal.

is_not_denormal

Computes the is_not_denormal.

is_not_equal

Computes the is_not_equal.

is_not_equal_with_equal_nans

Computes the is_not_equal_with_equal_nans.

is_not_greater

Computes the is_not_greater.

is_not_greater_equal

Computes the is_not_greater_equal.

is_not_imag

Computes the is_not_imag.

is_not_less

Computes the is_not_less.

is_not_less_equal

Computes the is_not_less_equal.

is_not_nan

Computes the is_not_nan.

is_not_real

Computes the is_not_real.

is_odd

Computes the is_odd.

is_ord

Computes the is_ord.

is_positive

Computes the is_positive.

is_real

Computes the is_real.

is_unord

Computes the is_unord.

ldexp

Computes the ldexp.

lo

Computes the lo.

log

Computes the log.

log10

Computes the log10.

log1p

Computes the log1p.

log2

Computes the log2.

logical_and

Computes the logical_and.

logical_andnot

Computes the logical_andnot.

logical_not

Computes the logical_not.

logical_notand

Computes the logical_notand.

logical_notor

Computes the logical_notor.

logical_or

Computes the logical_or.

logical_ornot

Computes the logical_ornot.

logical_xor

Computes the logical_xor.

mantissa

Computes the mantissa.

max

Computes the max.

maxmag

Computes the maxmag.

maxnum

Computes the maxnum.

maxnummag

Computes the maxnummag.

meanof

Computes the meanof.

min

Computes the min.

minmag

Computes the minmag.

minmod

Computes the minmod.

minnum

Computes the minnum.

minnummag

Computes the minnummag.

minus

Computes the minus.

multiplies

Computes the multiplies.

nearbyint

Computes the nearbyint.

negate

Computes the negate.

negatenz

Computes the negatenz.

next

Computes the next.

nextafter

Computes the nextafter.

nextpow2

Computes the nextpow2.

nthroot

Computes the nthroot.

oneminus

Computes the oneminus.

plus

Computes the plus.

popcnt

Computes the popcnt.

pow

Computes the pow.

pow2

Computes the pow2.

pow_abs

Computes the pow_abs.

prev

Computes the prev.

rec

Computes the rec.

rem

Computes the rem.

rem_2pi

Computes the rem_2pi.

reversebits

Computes the reversebits.

rol

Computes the rol.

ror

Computes the ror.

round

Computes the round.

rrol

Computes the rrol.

rror

Computes the rror.

rsqrt

Computes the rsqrt.

safe_max

Computes the safe_max.

safe_min

Computes the safe_min.

sbits

Computes the sbits.

sec

Computes the sec.

secd

Computes the secd.

sech

Computes the sech.

secpi

Computes the secpi.

shift_left

Computes the shift_left.

shift_right

Computes the shift_right.

shl

Computes the shl.

shr

Computes the shr.

sign

Computes the sign.

signbit

Computes the signbit.

signgam

Computes the signgam.

significants

Computes the significants.

signnz

Computes the signnz.

sin

Computes the sin.

sinc

Computes the sinc.

sincpi

Computes the sincpi.

sind

Computes the sind.

sinh

Computes the sinh.

sinhc

Computes the sinhc.

sinpi

Computes the sinpi.

sqr

Computes the sqr.

sqr_abs

Computes the sqr_abs.

sqrt

Computes the sqrt.

sqrt1pm1

Computes the sqrt1pm1.

stirling

Computes the stirling.

tan

Computes the tan.

tand

Computes the tand.

tanh

Computes the tanh.

tanpi

Computes the tanpi.

tenpower

Computes the tenpower.

tofloat

Computes the tofloat.

toint

Computes the toint.

touint

Computes the touint.

trunc

Computes the trunc.

twopower

Computes the twopower.

ulp

Computes the ulp.

ulpdist

Computes the ulpdist.

unary_minus

Computes the unary_minus.

unary_plus

Computes the unary_plus.