OpsTensorRanked.hs

{-# OPTIONS_GHC -fplugin GHC.TypeLits.KnownNat.Solver #-}
{-# OPTIONS_GHC -fplugin GHC.TypeLits.Normalise #-}
-- | The ranked tensor operations intended for the casual library user.
-- All these operations together with operations of the remaining two tensor
-- variants are gathered in "HordeAd.OpsTensor".
--
-- The less user-friendly
-- prototypes of most of these operation can be found in "HordeAd.Core.Ops"
-- where some additional rarely used operations reside.
-- All these operations, together with instances of numerical classes
-- such as @Num@, @Fractional@, @IntegralH@, @RealFloatH@, @EqH@ and others
-- (see class instances of type 'HordeAd.Core.Ast.AstTensor' for the full list),
-- are a major part of the high-level API of the horde-ad library,
-- which is relatively orthogonal to the other major part,
-- the differentiation interface exposed in "HordeAd.ADEngine".
module HordeAd.OpsTensorRanked
  ( -- * Shape manipulation
    rshape, rlength, rsize, rwidth
  , tsize, tftk
    -- * Constructing arrays from concrete values, lists and vectors
  , kconcrete, rconcrete, rscalar, rrepl, ringestData, rfromListLinear
  , rfromList, rfromVector, rfromVectorN, rfromVectorLinear
  , runravelToList, runravelToListN, rtoListLinear
    -- * Main array operations
  , tunit, tlet, tletPrimal, tletPlain, ifH, minH, maxH
  , tpair, tproject1, tproject2
  , rsum, rsumN, rsum0, rdot0, rdot1In, rmatvecmul, rmatmul2
  , rreplicate, rreplicate0N, rreplicateN
  , rindex, (!), rindex0, roneHot, rscatter, rscatter1, rgather, rgather1
  , rtr, rtranspose, rflatten, rreshape
   -- * Auxiliary array operations
  , kfloor, kfromIntegral, kcast
  , rfloor, rfromIntegral, rcast, rargMin, rargMax, riota
  , rappend, rconcat, rslice, runcons, rreverse
    -- * Array operations derived from @build@
  , rbuild, rbuild1, rmap, rmap1, rmap0N, rzipWith, rzipWith1, rzipWith0N
  , rzipWith3, rzipWith31, rzipWith30N, rzipWith4, rzipWith41, rzipWith40N
    -- * Array operations derived from @mapAccum@
  , rfold, rscan, tfold, tscan, tmapAccumR, tmapAccumL
    -- * Array operations producing derivatives
  , kgrad, rvjp, rjvp
    -- * Operations dealing with dual numbers
  , kprimalPart, kdualPart, kfromPrimal, kfromDual, kScale
  , rprimalPart, rdualPart, rfromPrimal, rfromDual, rScale
    -- * Array operations that utilize unwinding of nested arrays
  , treplTarget, tdefTarget, taddTarget, tmultTarget, tsum0Target, tdot0Target
    -- * Minimal re-exports to make this module a higher level replacement for the ranked part of "HordeAd.Core.Ops"
  , ADReady, ADReadyNoLet, ShareTensor
  , LetTensor, BaseTensor
  ) where

import Prelude ()

import HordeAd.OpsTensor