API Reference

Main functions

detkit.logdet(A[, sym_pos, overwrite_A, ...])	Computes the logdet of a matrix.
detkit.loggdet(A, X[, Xp, method, sym_pos, ...])	Computes the loggdet of a matrix.
detkit.logpdet(A, X[, Xp, method, sym_pos, ...])	Computes the logpdet of a matrix.

Orthogonalization

detkit.orthogonalize(A)	Orthogonalizes the columns of matrix.
detkit.ortho_complement(Xp, X[, X_orth])	Orthogonalizes the columns of matrix Xp against X.

Datasets

detkit.electrocardiogram([start, end, ...])	Load an electrocardiogram signal as an example for a 1D signal.
detkit.covariance_matrix([size, sample, ...])	Create covariance matrix based on the autocorrelation of electrocardiogram signal.
detkit.design_matrix([num_rows, num_cols, ortho])	Generate design matrix.

Utilities

detkit.get_config([key])	Returns the definitions used in the compile-time of the package.
detkit.get_instructions_per_task([task, dtype])	Counts the hardware instructions of computing a single FLOP of a benchmark task on the current processor.