Safe Haskell	None
Language	Haskell2010

DataFrame.Typed.Types

Contents

Core phantom-typed wrapper
Column phantom type (no constructors)
Typed expressions (schema-validated)
Typed sort orders
Grouped typed dataframe
Typed aggregation builder (Option B)
Re-export These

Synopsis

newtype TypedDataFrame (cols :: [Type]) = TDF {
- unTDF :: DataFrame
}
data Column (name :: Symbol) a
newtype TExpr (cols :: [Type]) a = TExpr {
- unTExpr :: Expr a
}
data TSortOrder (cols :: [Type]) where
- Asc :: forall a (cols :: [Type]). Columnable a => TExpr cols a -> TSortOrder cols
- Desc :: forall a (cols :: [Type]). Columnable a => TExpr cols a -> TSortOrder cols
newtype TypedGrouped (keys :: [Symbol]) (cols :: [Type]) = TGD {
- unTGD :: GroupedDataFrame
}
data TAgg (keys :: [Symbol]) (cols :: [Type]) (aggs :: [Type]) where
- TAggNil :: forall (keys :: [Symbol]) (cols :: [Type]). TAgg keys cols ('[] :: [Type])
- TAggCons :: forall a (cols :: [Type]) (keys :: [Symbol]) (aggs1 :: [Type]) (name :: Symbol). Columnable a => Text -> TExpr cols a -> TAgg keys cols aggs1 -> TAgg keys cols (Column name a ': aggs1)
taggToNamedExprs :: forall (keys :: [Symbol]) (cols :: [Type]) (aggs :: [Type]). TAgg keys cols aggs -> [NamedExpr]
data These a b
- = This a
- | That b
- | These a b

Core phantom-typed wrapper

newtype TypedDataFrame (cols :: [Type]) Source #

A phantom-typed wrapper over the untyped DataFrame.

The type parameter cols is a type-level list of Column name ty entries that tracks the schema at compile time. All operations delegate to the untyped core at runtime and update the phantom type at compile time.

Constructors

TDF
Fields unTDF :: DataFrame

Instances

Instances details

Show (TypedDataFrame cols) Source #
Instance details Defined in DataFrame.Typed.Types Methods showsPrec :: Int -> TypedDataFrame cols -> ShowS # show :: TypedDataFrame cols -> String # showList :: [TypedDataFrame cols] -> ShowS #
Eq (TypedDataFrame cols) Source #
Instance details Defined in DataFrame.Typed.Types Methods (==) :: TypedDataFrame cols -> TypedDataFrame cols -> Bool # (/=) :: TypedDataFrame cols -> TypedDataFrame cols -> Bool #

Column phantom type (no constructors)

data Column (name :: Symbol) a Source #

A phantom type that pairs a type-level column name (Symbol) with its element type. Has no value-level constructors — used purely at the type level to describe schemas.

Instances

Instances details

(KnownSymbol name, Typeable a, Columnable a, KnownSchema rest) => KnownSchema (Column name a ': rest) Source #
Instance details Defined in DataFrame.Typed.Schema Methods schemaEvidence :: [(Text, SomeTypeRep)] Source #

Typed expressions (schema-validated)

newtype TExpr (cols :: [Type]) a Source #

A typed expression validated against schema cols, producing values of type a.

Unlike the untyped 'Expr a', a TExpr can only be constructed through type-safe combinators (col, lit, arithmetic operations) that verify column references exist in the schema with the correct type.

Use unTExpr to extract the underlying Expr for delegation to the untyped API.

Constructors

TExpr
Fields unTExpr :: Expr a

Instances

Instances details

(IsString a, Columnable a) => IsString (TExpr cols a) Source #
Instance details Defined in DataFrame.Typed.Expr Methods fromString :: String -> TExpr cols a #
(Floating a, Columnable a) => Floating (TExpr cols a) Source #
Instance details Defined in DataFrame.Typed.Expr Methods pi :: TExpr cols a # exp :: TExpr cols a -> TExpr cols a # log :: TExpr cols a -> TExpr cols a # sqrt :: TExpr cols a -> TExpr cols a # (**) :: TExpr cols a -> TExpr cols a -> TExpr cols a # logBase :: TExpr cols a -> TExpr cols a -> TExpr cols a # sin :: TExpr cols a -> TExpr cols a # cos :: TExpr cols a -> TExpr cols a # tan :: TExpr cols a -> TExpr cols a # asin :: TExpr cols a -> TExpr cols a # acos :: TExpr cols a -> TExpr cols a # atan :: TExpr cols a -> TExpr cols a # sinh :: TExpr cols a -> TExpr cols a # cosh :: TExpr cols a -> TExpr cols a # tanh :: TExpr cols a -> TExpr cols a # asinh :: TExpr cols a -> TExpr cols a # acosh :: TExpr cols a -> TExpr cols a # atanh :: TExpr cols a -> TExpr cols a # log1p :: TExpr cols a -> TExpr cols a # expm1 :: TExpr cols a -> TExpr cols a # log1pexp :: TExpr cols a -> TExpr cols a # log1mexp :: TExpr cols a -> TExpr cols a #
(Num a, Columnable a) => Num (TExpr cols a) Source #
Instance details Defined in DataFrame.Typed.Expr Methods (+) :: TExpr cols a -> TExpr cols a -> TExpr cols a # (-) :: TExpr cols a -> TExpr cols a -> TExpr cols a # (*) :: TExpr cols a -> TExpr cols a -> TExpr cols a # negate :: TExpr cols a -> TExpr cols a # abs :: TExpr cols a -> TExpr cols a # signum :: TExpr cols a -> TExpr cols a # fromInteger :: Integer -> TExpr cols a #
(Fractional a, Columnable a) => Fractional (TExpr cols a) Source #
Instance details Defined in DataFrame.Typed.Expr Methods (/) :: TExpr cols a -> TExpr cols a -> TExpr cols a # recip :: TExpr cols a -> TExpr cols a # fromRational :: Rational -> TExpr cols a #

Typed sort orders

data TSortOrder (cols :: [Type]) where Source #

A typed sort order validated against schema cols.

Constructors

Asc :: forall a (cols :: [Type]). Columnable a => TExpr cols a -> TSortOrder cols
Desc :: forall a (cols :: [Type]). Columnable a => TExpr cols a -> TSortOrder cols

Grouped typed dataframe

newtype TypedGrouped (keys :: [Symbol]) (cols :: [Type]) Source #

A phantom-typed wrapper over GroupedDataFrame.

Constructors

TGD
Fields unTGD :: GroupedDataFrame

Typed aggregation builder (Option B)

data TAgg (keys :: [Symbol]) (cols :: [Type]) (aggs :: [Type]) where Source #

A typed aggregation builder (Option B).

Accumulates NamedExpr values at the term level while building the result schema at the type level. Each agg call prepends a Column to the aggs phantom list.

Usage:

agg @"total" (F.sum salary)
  $ agg @"avg_age" (F.mean age)
  $ aggNil

Constructors

TAggNil :: forall (keys :: [Symbol]) (cols :: [Type]). TAgg keys cols ('[] :: [Type])
TAggCons
Fields :: forall a (cols :: [Type]) (keys :: [Symbol]) (aggs1 :: [Type]) (name :: Symbol). Columnable a => Text column name -> TExpr cols a typed aggregation expression -> TAgg keys cols aggs1 rest -> TAgg keys cols (Column name a ': aggs1)

taggToNamedExprs :: forall (keys :: [Symbol]) (cols :: [Type]) (aggs :: [Type]). TAgg keys cols aggs -> [NamedExpr] Source #

Extract the runtime NamedExpr list from a TAgg, in declaration order (reversed from the cons-built order).

Re-export These

data These a b #

The These type represents values with two non-exclusive possibilities.

This can be useful to represent combinations of two values, where the combination is defined if either input is. Algebraically, the type These A B represents (A + B + AB), which doesn't factor easily into sums and products--a type like Either A (B, Maybe A) is unclear and awkward to use.

These has straightforward instances of Functor, Monad, &c., and behaves like a hybrid error/writer monad, as would be expected.

For zipping and unzipping of structures with These values, see Data.Align.

Constructors