API documentation

lazylinop core module:

API listing:

• Lazylinop core module
  • LazyLinOp class
    • lazylinop.LazyLinOp
    • Attributes
      • lazylinop.LazyLinOp.T
      • lazylinop.LazyLinOp.H
      • lazylinop.LazyLinOp.ndim
      • lazylinop.LazyLinOp.shape
      • lazylinop.LazyLinOp.real
      • lazylinop.LazyLinOp.imag
    • Methods
      • lazylinop.LazyLinOp.toarray()
      • lazylinop.LazyLinOp.conj()
      • lazylinop.LazyLinOp.__pow__()
  • Module utility functions
    • lazylinop.islazylinop()
    • lazylinop.aslazylinop()
• Basic operators
  • Construction
    • lazylinop.anti_diag()
    • lazylinop.anti_eye()
    • lazylinop.diag()
    • lazylinop.diff()
    • lazylinop.eye()
    • lazylinop.ones()
    • lazylinop.tri()
    • lazylinop.cumsum()
    • lazylinop.zeros()
    • lazylinop.padder()
  • Agglomeration & Transformation
    • lazylinop.add()
    • lazylinop.block_diag()
    • lazylinop.hstack()
    • lazylinop.kron()
    • lazylinop.pad()
    • lazylinop.vstack()
  • Slicing and indexing operators
    • lazylinop.basicops.slicer()
    • lazylinop.basicops.indexer()
  • Permutations operators
    • lazylinop.basicops.bitrev()
    • lazylinop.basicops.flip()
    • lazylinop.basicops.roll()
• Butterfly module
  • Preamble
  • References
  • Butterfly construction
    • lazylinop.butterfly.ksd()
    • lazylinop.butterfly.ksm()
    • lazylinop.butterfly.fuse()
    • lazylinop.butterfly.dft()
    • lazylinop.butterfly.fwht()
    • lazylinop.butterfly.hadamard()
  • Chain class
    • lazylinop.butterfly.Chain
    • lazylinop.butterfly.Chain.square_dyadic()
    • lazylinop.butterfly.Chain.monarch()
    • lazylinop.butterfly.Chain.wip_non_redundant()
  • Chain methods
    • lazylinop.butterfly.Chain.mem()
    • lazylinop.butterfly.Chain.plot()
  • I/O (load/save)
    • lazylinop.butterfly.load()
    • lazylinop.butterfly.save()
  • Plot
    • lazylinop.butterfly.plot()
• Linear algebra module
  • lazylinop.linalg.svds()
• Polynomial module
  • Polynomial classes
    • lazylinop.polynomial.Polynomial
    • lazylinop.polynomial.Chebyshev
    • lazylinop.polynomial.Hermite
    • lazylinop.polynomial.HermiteE
    • lazylinop.polynomial.Laguerre
    • lazylinop.polynomial.Legendre
  • Polynomial functions
    • lazylinop.polynomial.xpoly()
    • lazylinop.polynomial.power()
• Signal module
  • List of transforms
  • Padding or cropping
  • Inverse transforms
  • Other normalizations
  • Transforms
    • lazylinop.signal.convolve()
    • lazylinop.signal.dct()
    • lazylinop.signal.dst()
    • lazylinop.signal.mdct()
    • lazylinop.signal.imdct()
    • lazylinop.signal.dft()
    • lazylinop.signal.wht()
    • lazylinop.signal.dwt()
    • lazylinop.signal.idwt()
    • lazylinop.signal.dzt()
    • lazylinop.signal.stft()
    • lazylinop.signal.istft()
    • lazylinop.signal.nufft()
  • Utility functions
    • lazylinop.signal.chunk()
    • lazylinop.signal.decimate()
    • lazylinop.signal.downsample()
    • lazylinop.signal.overlap_add()
    • lazylinop.signal.dwt_coeffs_sizes()
    • lazylinop.signal.dwt_to_pywt_coeffs()
• 2d signal module
  • List of transforms
  • Input (and output) vector shape
  • Padding or cropping
  • Inverse transforms
  • Various normalizations
  • Transforms
    • lazylinop.signal2d.convolve2d()
    • lazylinop.signal2d.dwt2d()
    • lazylinop.signal2d.idwt2d()
    • lazylinop.signal2d.dft2d()
    • lazylinop.signal2d.fft2d()
    • lazylinop.signal2d.dct2d()
    • lazylinop.signal2d.dst2d()
    • lazylinop.signal2d.mdct2d()
    • lazylinop.signal2d.padder2d()
  • Utility functions
    • lazylinop.signal2d.flatten()
    • lazylinop.signal2d.unflatten()
    • lazylinop.signal2d.dwt2d_to_pywt_coeffs()
    • lazylinop.signal2d.dwt2d_coeffsshapes()
    • lazylinop.signal2d.colvec()
    • lazylinop.signal2d.uncolvec()
• Work-in-Progress modules
  • Linear algebra module
    • lazylinop.wip.linalg.coshm()
    • lazylinop.wip.linalg.cosm()
    • lazylinop.wip.linalg.expm()
    • lazylinop.wip.linalg.logm()
    • lazylinop.wip.linalg.sinhm()
    • lazylinop.wip.linalg.sinm()
    • lazylinop.wip.linalg.sqrtm()
    • lazylinop.wip.linalg.spectral_norm()
  • Special matrices module
    • lazylinop.wip.special_matrices.alternant()
    • lazylinop.wip.special_matrices.companion()
    • lazylinop.wip.special_matrices.fiedler()
    • lazylinop.wip.special_matrices.helmert()
    • lazylinop.wip.special_matrices.hilbert()
    • lazylinop.wip.special_matrices.householder_matrix()
    • lazylinop.wip.special_matrices.h_multiply()
    • lazylinop.wip.special_matrices.lehmer()
    • lazylinop.wip.special_matrices.leslie()
    • lazylinop.wip.special_matrices.pascal()
    • lazylinop.wip.special_matrices.redheffer()
    • lazylinop.wip.special_matrices.sylvester()
    • lazylinop.wip.special_matrices.vander()
  • Parallel computing
    • pmatmat functions
      • lazylinop.wip.parallel.pmatmat()
      • lazylinop.wip.parallel.pmatmat_multithread()
      • lazylinop.wip.parallel.pmatmat_multiprocess()
      • lazylinop.wip.parallel.pmatmat_mpi()
    • MPILop operator
      • lazylinop.wip.parallel.MPILop
  • Random functions
    • lazylinop.wip.random.rand()
  • Basicops operators (WIP)
    • lazylinop.wip.basicops.average()
    • lazylinop.wip.basicops.mean()
    • lazylinop.wip.basicops.khatri_rao()
  • Butterfly module
    • Butterfly construction
      • lazylinop.wip.butterfly.dft.dft_helper()
      • lazylinop.wip.butterfly.dct.dct_helper()
      • lazylinop.wip.butterfly.dst.dst_helper()
    • Fuse
      • lazylinop.wip.butterfly.fuses.fuses()
    • Utilities
      • lazylinop.wip.butterfly.utils.clean()
      • lazylinop.wip.butterfly.utils.del_all_contexts()
  • Quantization module
    • References
    • Rank one quantization
      • lazylinop.wip.quantization.qrank_one()
    • Monarch quantization
      • lazylinop.wip.quantization.qmonarch()
    • Butterfly quantization
      • lazylinop.wip.quantization.qbutterfly()
    • Utils
      • lazylinop.wip.quantization.chop()
      • lazylinop.wip.quantization.finfo()
      • lazylinop.wip.quantization.promote_types()