Documentation
¶
Overview ¶
Package nd applies the special functions of package special element-wise to go-ndarray arrays (github.com/go-ndarray/ndarray).
Every real dtype is accepted. A Float32 input gives a Float32 result (computed in float64 and rounded once); Float64, integer and Bool inputs give Float64. Complex inputs are rejected with ndarray.ErrDType. Functions of several arguments broadcast them against each other as NumPy does. Large arrays are split across GOMAXPROCS goroutines.
Each function documents nothing beyond its scalar counterpart in package special, whose accuracy and conventions it inherits exactly: the element results are bit-identical to calling the scalar function.
Index ¶
- Variables
- func Beta(a, b *ndarray.Array) (*ndarray.Array, error)
- func BetaInc(a, b, x *ndarray.Array) (*ndarray.Array, error)
- func BetaIncC(a, b, x *ndarray.Array) (*ndarray.Array, error)
- func BetaIncCInv(a, b, q *ndarray.Array) (*ndarray.Array, error)
- func BetaIncInv(a, b, p *ndarray.Array) (*ndarray.Array, error)
- func Binom(a, b *ndarray.Array) (*ndarray.Array, error)
- func Comb(n, k *ndarray.Array) (*ndarray.Array, error)
- func Digamma(x *ndarray.Array) (*ndarray.Array, error)
- func EllipE(x *ndarray.Array) (*ndarray.Array, error)
- func EllipK(x *ndarray.Array) (*ndarray.Array, error)
- func EllipKm1(x *ndarray.Array) (*ndarray.Array, error)
- func Erf(x *ndarray.Array) (*ndarray.Array, error)
- func ErfInv(x *ndarray.Array) (*ndarray.Array, error)
- func Erfc(x *ndarray.Array) (*ndarray.Array, error)
- func ErfcInv(x *ndarray.Array) (*ndarray.Array, error)
- func Erfcx(x *ndarray.Array) (*ndarray.Array, error)
- func Expit(x *ndarray.Array) (*ndarray.Array, error)
- func Factorial(x *ndarray.Array) (*ndarray.Array, error)
- func Factorial2(n *ndarray.Array) (*ndarray.Array, error)
- func Gamma(x *ndarray.Array) (*ndarray.Array, error)
- func GammaP(a, x *ndarray.Array) (*ndarray.Array, error)
- func GammaPInv(a, p *ndarray.Array) (*ndarray.Array, error)
- func GammaQ(a, x *ndarray.Array) (*ndarray.Array, error)
- func GammaQInv(a, q *ndarray.Array) (*ndarray.Array, error)
- func GammaSign(x *ndarray.Array) (*ndarray.Array, error)
- func HurwitzZeta(a, b *ndarray.Array) (*ndarray.Array, error)
- func I0(x *ndarray.Array) (*ndarray.Array, error)
- func I0e(x *ndarray.Array) (*ndarray.Array, error)
- func I1(x *ndarray.Array) (*ndarray.Array, error)
- func I1e(x *ndarray.Array) (*ndarray.Array, error)
- func In(n, x *ndarray.Array) (*ndarray.Array, error)
- func Iv(v, x *ndarray.Array) (*ndarray.Array, error)
- func Ive(v, x *ndarray.Array) (*ndarray.Array, error)
- func J0(x *ndarray.Array) (*ndarray.Array, error)
- func J1(x *ndarray.Array) (*ndarray.Array, error)
- func Jn(n, x *ndarray.Array) (*ndarray.Array, error)
- func Jv(v, x *ndarray.Array) (*ndarray.Array, error)
- func K0(x *ndarray.Array) (*ndarray.Array, error)
- func K0e(x *ndarray.Array) (*ndarray.Array, error)
- func K1(x *ndarray.Array) (*ndarray.Array, error)
- func K1e(x *ndarray.Array) (*ndarray.Array, error)
- func Kn(n, x *ndarray.Array) (*ndarray.Array, error)
- func Kv(v, x *ndarray.Array) (*ndarray.Array, error)
- func Kve(v, x *ndarray.Array) (*ndarray.Array, error)
- func Log1pExp(x *ndarray.Array) (*ndarray.Array, error)
- func LogBeta(a, b *ndarray.Array) (*ndarray.Array, error)
- func LogExpit(x *ndarray.Array) (*ndarray.Array, error)
- func LogFactorial(x *ndarray.Array) (*ndarray.Array, error)
- func LogGamma(x *ndarray.Array) (*ndarray.Array, error)
- func LogNdtr(x *ndarray.Array) (*ndarray.Array, error)
- func LogSoftmax(x *ndarray.Array) (*ndarray.Array, error)
- func LogSumExp(x *ndarray.Array) (float64, error)
- func Logit(x *ndarray.Array) (*ndarray.Array, error)
- func Map1(f func(float64) float64, a *ndarray.Array) (*ndarray.Array, error)
- func Map2(f func(x, y float64) float64, a, b *ndarray.Array) (*ndarray.Array, error)
- func Map3(f func(x, y, z float64) float64, a, b, c *ndarray.Array) (*ndarray.Array, error)
- func Ndtr(x *ndarray.Array) (*ndarray.Array, error)
- func Ndtri(x *ndarray.Array) (*ndarray.Array, error)
- func Perm(n, k *ndarray.Array) (*ndarray.Array, error)
- func Polygamma(n, x *ndarray.Array) (*ndarray.Array, error)
- func Softmax(x *ndarray.Array) (*ndarray.Array, error)
- func Xlog1py(a, b *ndarray.Array) (*ndarray.Array, error)
- func Xlogy(a, b *ndarray.Array) (*ndarray.Array, error)
- func Y0(x *ndarray.Array) (*ndarray.Array, error)
- func Y1(x *ndarray.Array) (*ndarray.Array, error)
- func Yn(n, x *ndarray.Array) (*ndarray.Array, error)
- func Yv(v, x *ndarray.Array) (*ndarray.Array, error)
- func Zeta(x *ndarray.Array) (*ndarray.Array, error)
Constants ¶
This section is empty.
Variables ¶
var ErrShape = errors.New("nd: shapes cannot be broadcast")
ErrShape is returned (wrapped) when arguments cannot be broadcast together.
Functions ¶
func BetaIncCInv ¶
BetaIncCInv applies special.BetaIncCInv element-wise to the broadcast arguments.
func BetaIncInv ¶
BetaIncInv applies special.BetaIncInv element-wise to the broadcast arguments.
func Comb ¶
Comb applies special.Comb element-wise to the broadcast arguments; arguments that are not integers give NaN.
func Factorial2 ¶
Factorial2 applies special.Factorial2 element-wise; non-integers give NaN.
func HurwitzZeta ¶
HurwitzZeta applies special.HurwitzZeta element-wise to the broadcast arguments.
func LogFactorial ¶
LogFactorial applies special.LogFactorial element-wise.
func LogSoftmax ¶
LogSoftmax returns x - LogSumExp(x) over all elements of x, with x's shape (special.LogSoftmax).
func Perm ¶
Perm applies special.Perm element-wise to the broadcast arguments; arguments that are not integers give NaN.
func Polygamma ¶
Polygamma applies special.Polygamma element-wise to the broadcast arguments; an n that is not an integer gives NaN.
func Softmax ¶
Softmax returns exp(x)/Σ exp(x) over all elements of x, with x's shape (special.Softmax).
Types ¶
This section is empty.
Source Files