DelayedTensor-package {DelayedTensor} | R Documentation

## R package for sparse and out-of-core arithmetic and decomposition of Tensor

### Description

DelayedTensor operates Tensor arithmetic directly on DelayedArray object. DelayedTensor provides some generic function related to Tensor arithmetic/decompotision and dispatches it on the DelayedArray class. DelayedTensor also suppors Tensor contraction by einsum function, which is inspired by numpy einsum.

### Details

The DESCRIPTION file:

Package: | DelayedTensor
Type: | Package
Title: | R package for sparse and out-of-core arithmetic and decomposition of Tensor
Version: | 1.0.0
Authors@R: | c(person("Koki", "Tsuyuzaki", role = c("aut", "cre"), email = "k.t.the-answer@hotmail.co.jp"))
Depends: | R (>= 4.1.0)
Imports: | methods, utils, DelayedArray, HDF5Array, BiocSingular, rTensor, DelayedRandomArray, irlba, Matrix, einsum,
Suggests: | markdown, rmarkdown, BiocStyle, knitr, testthat, magrittr, dplyr, reticulate
Description: | DelayedTensor operates Tensor arithmetic directly on DelayedArray object. DelayedTensor provides some generic function related to Tensor arithmetic/decompotision and dispatches it on the DelayedArray class. DelayedTensor also suppors Tensor contraction by einsum function, which is inspired by numpy einsum.
License: | Artistic-2.0
biocViews: | Software, Infrastructure, DataRepresentation, DimensionReduction
LazyData: | true
LazyDataCompression: | xz
VignetteBuilder: | knitr
BugReports: | https://github.com/rikenbit/DelayedTensor/issues
git_url: | https://git.bioconductor.org/packages/DelayedTensor
git_branch: | RELEASE_3_14
git_last_commit: | feff2b4
git_last_commit_date: | 2021-10-26
Date/Publication: | 2021-10-26
Author: | Koki Tsuyuzaki [aut, cre]
Maintainer: | Koki Tsuyuzaki <k.t.the-answer@hotmail.co.jp>

Index of help topics:

    DelayedDiagonalArray    Diagonal DelayedArray
    DelayedTensor-package   R package for sparse and out-of-core arithmetic
                            and decomposition of Tensor
    cbind_list              Mode-binding against list
    cp-methods              Canonical Polyadic Decomposition
    cs_fold-methods         Column Space Folding of 2D DelayedArray
    cs_unfold-methods       Tensor Column Space Unfolding of DelayedArray
    diag-methods            DelayedArray Diagonals
    einsum                  Einstein Summation of DelayedArray
    fnorm-methods           Tensor Frobenius Norm of DelayedArray
    fold-methods            Tensor folding of 2D DelayedArray
    getSparse               Getter of the intermediate/output DelayedArray
                            object in DelayedTensor
    getVerbose              Getter function to control the verbose messages
                            from DelayedTensor
    hadamard-methods        Hadamard Product of DelayedArray
    hadamard_list           Hadamard Product against list
    hosvd-methods           (Truncated-)Higher-order SVD
    human_mid_brain         Matrix object of human mid brain data
    innerProd-methods       Tensors Inner Product of DelayedArray
    k_fold-methods          k-mode Folding of 2D DelayedArray
    k_unfold-methods        Tensor k-mode Unfolding of DelayedArray
    khatri_rao-methods      Khatri-Rao Product of DelayedArray
    khatri_rao_list         Khatri-Rao Product against list
    kronecker-methods       Kronecker Product of DelayedArray
    kronecker_list          Kronecker Product against list
    list_rep                Replicate of arbitrary object
    matvec-methods          Tensor Matvec Unfolding of DelayedArray
    modeMean-methods        Tensor Mean Across Single Mode of DelayedArray
    modeSum-methods         Tensor Sum Across Single Mode of DelayedArray
    modebind_list           Mode-binding against list
    mouse_mid_brain         Matrix object of mouse mid brain data
    mpca-methods            Multilinear Principal Components Analysis
    outerProd-methods       Tensors Outer Product of DelayedArray
    pvd-methods             Population Value Decomposition
    rbind_list              Mode-binding against list
    rs_fold-methods         Row Space Folding of 2D DelayedArray
    rs_unfold-methods       Tensor Row Space Unfolding of DelayedArray
    setSparse               Setter to set the intermediate DelayedArray
                            object in DelayedTensor
    setVerbose              Setter to set the verbose mode of DelayedTensor
    ttl                     DelayedArray Times List
    ttm-methods             Tensor Times Matrix (m-Mode Product)
    tucker-methods          Tucker Decomposition
    unfold-methods          Tensor Unfolding of 2D DelayedArray
    unmatvec-methods        Unmatvec Folding of 2D DelayedArray
    vec-methods             Tensor Vectorization of DelayedArray

### Author(s)

NA

Maintainer: NA

### See Also

# Unfold operations `unfold`, `k_unfold`, `matvec`, `rs_unfold`, `cs_unfold`, `ttl` # Fold operations `fold`, `k_fold`, `unmatvec`, `rs_fold`, `cs_fold`, `ttm` # Vectorization `vec` # Norm operations `fnorm`, `innerProd` # Diagonal operations / Diagonal Tensor `diag`, `DelayedDiagonalArray` # Mode-wise operations `modeSum`, `modeMean` # Tensor product operations `hadamard`, `hadamard_list`, `kronecker`, `kronecker_list`, `khatri_rao`, `khatri_rao_list` # Utilities `list_rep`, `modebind_list`, `rbind_list`, `cbind_list` # Decomposition operations `hosvd`, `cp`, `tucker`, `mpca`, `pvd` # Einsum operation `einsum`

### Examples

    ls("package:DelayedTensor")

[Package DelayedTensor version 1.0.0 Index]