Copyright	(C) 2013 Amgen, Inc.
Safe Haskell	None
Language	Haskell2010

Foreign.R.Type

Description

Definition of SEXPTYPE, which classifies the possible forms of an R expression (a SEXP). It is normally not necessary to import this module directly, since it is reexported by Foreign.R.

This is done in a separate module because we want to use hsc2hs rather than c2hs for discharging the boilerplate around SEXPTYPE. This is because SEXPTYPE is nearly but not quite a true enumeration and c2hs has trouble dealing with that.

This module also defines a singleton version of SEXPTYPE, called SSEXPTYPE. This is actually a family of types, one for each possible SEXPTYPE. Singleton types are a way of emulating dependent types in a language that does not have true dependent type. They are useful in functions whose result type depends on the value of one of its arguments. See e.g. allocVector.

Synopsis

Documentation

data SEXPTYPE Source

R "type". Note that what R calls a "type" is not what is usually meant by the term: there is really only a single type, called SEXP, and an R "type" in fact refers to the class or form of the expression.

To better illustrate the distinction, note that any sane type system normally has the subject reduction property: that the type of an expression is invariant under reduction. For example, (x -> x) 1 has type Int, and so does the value of this expression, 2, have type Int. Yet the form of the expression is an application of a function to a literal, while the form of its reduct is an integer literal.

We introduce convenient Haskell-like names for forms because this datatype is used to index SEXP and other types through the DataKinds extension.

Constructors

Nil
Symbol
List
Closure
Env
Promise
Lang
Special
Builtin
Char
Logical
Int
Real
Complex
String
DotDotDot
Any
Vector
Expr
Bytecode
ExtPtr
WeakRef
Raw
S4
New
Free
Fun

Instances

Enum SEXPTYPE Source
Methods succ :: SEXPTYPE -> SEXPTYPE pred :: SEXPTYPE -> SEXPTYPE toEnum :: Int -> SEXPTYPE fromEnum :: SEXPTYPE -> Int enumFrom :: SEXPTYPE -> [SEXPTYPE] enumFromThen :: SEXPTYPE -> SEXPTYPE -> [SEXPTYPE] enumFromTo :: SEXPTYPE -> SEXPTYPE -> [SEXPTYPE] enumFromThenTo :: SEXPTYPE -> SEXPTYPE -> SEXPTYPE -> [SEXPTYPE]
Eq SEXPTYPE Source
Methods (==) :: SEXPTYPE -> SEXPTYPE -> Bool (/=) :: SEXPTYPE -> SEXPTYPE -> Bool
Ord SEXPTYPE Source
Methods compare :: SEXPTYPE -> SEXPTYPE -> Ordering (<) :: SEXPTYPE -> SEXPTYPE -> Bool (<=) :: SEXPTYPE -> SEXPTYPE -> Bool (>) :: SEXPTYPE -> SEXPTYPE -> Bool (>=) :: SEXPTYPE -> SEXPTYPE -> Bool max :: SEXPTYPE -> SEXPTYPE -> SEXPTYPE min :: SEXPTYPE -> SEXPTYPE -> SEXPTYPE
Show SEXPTYPE Source
Methods showsPrec :: Int -> SEXPTYPE -> ShowS show :: SEXPTYPE -> String showList :: [SEXPTYPE] -> ShowS
NFData SEXPTYPE Source
Methods rnf :: SEXPTYPE -> ()
Lift SEXPTYPE Source
Methods lift :: SEXPTYPE -> Q Exp
SingI SEXPTYPE Nil Source
Methods sing :: Sing k Nil
SingI SEXPTYPE Symbol Source
Methods sing :: Sing k Symbol
SingI SEXPTYPE List Source
Methods sing :: Sing k List
SingI SEXPTYPE Closure Source
Methods sing :: Sing k Closure
SingI SEXPTYPE Env Source
Methods sing :: Sing k Env
SingI SEXPTYPE Promise Source
Methods sing :: Sing k Promise
SingI SEXPTYPE Lang Source
Methods sing :: Sing k Lang
SingI SEXPTYPE Special Source
Methods sing :: Sing k Special
SingI SEXPTYPE Builtin Source
Methods sing :: Sing k Builtin
SingI SEXPTYPE Char Source
Methods sing :: Sing k Char
SingI SEXPTYPE Logical Source
Methods sing :: Sing k Logical
SingI SEXPTYPE Int Source
Methods sing :: Sing k Int
SingI SEXPTYPE Real Source
Methods sing :: Sing k Real
SingI SEXPTYPE Complex Source
Methods sing :: Sing k Complex
SingI SEXPTYPE String Source
Methods sing :: Sing k String
SingI SEXPTYPE DotDotDot Source
Methods sing :: Sing k DotDotDot
SingI SEXPTYPE Any Source
Methods sing :: Sing k Any
SingI SEXPTYPE Vector Source
Methods sing :: Sing k Vector
SingI SEXPTYPE Expr Source
Methods sing :: Sing k Expr
SingI SEXPTYPE Bytecode Source
Methods sing :: Sing k Bytecode
SingI SEXPTYPE ExtPtr Source
Methods sing :: Sing k ExtPtr
SingI SEXPTYPE WeakRef Source
Methods sing :: Sing k WeakRef
SingI SEXPTYPE Raw Source
Methods sing :: Sing k Raw
SingI SEXPTYPE S4 Source
Methods sing :: Sing k S4
SingI SEXPTYPE New Source
Methods sing :: Sing k New
SingI SEXPTYPE Free Source
Methods sing :: Sing k Free
SingI SEXPTYPE Fun Source
Methods sing :: Sing k Fun
TestEquality SEXPTYPE (HExp s)
Methods testEquality :: HExp s a -> HExp s b -> Maybe ((k :~: a) b)
SingKind SEXPTYPE (KProxy SEXPTYPE) Source
Associated Types type DemoteRep (KProxy SEXPTYPE :: KProxy k) :: * Methods fromSing :: Sing k a -> DemoteRep k (KProxy SEXPTYPE) toSing :: DemoteRep k (KProxy SEXPTYPE) -> SomeSing k (KProxy SEXPTYPE)
data Sing SEXPTYPE where SNil :: (~) SEXPTYPE z Nil => Sing SEXPTYPE z SSymbol :: (~) SEXPTYPE z Symbol => Sing SEXPTYPE z SList :: (~) SEXPTYPE z List => Sing SEXPTYPE z SClosure :: (~) SEXPTYPE z Closure => Sing SEXPTYPE z SEnv :: (~) SEXPTYPE z Env => Sing SEXPTYPE z SPromise :: (~) SEXPTYPE z Promise => Sing SEXPTYPE z SLang :: (~) SEXPTYPE z Lang => Sing SEXPTYPE z SSpecial :: (~) SEXPTYPE z Special => Sing SEXPTYPE z SBuiltin :: (~) SEXPTYPE z Builtin => Sing SEXPTYPE z SChar :: (~) SEXPTYPE z Char => Sing SEXPTYPE z SLogical :: (~) SEXPTYPE z Logical => Sing SEXPTYPE z SInt :: (~) SEXPTYPE z Int => Sing SEXPTYPE z SReal :: (~) SEXPTYPE z Real => Sing SEXPTYPE z SComplex :: (~) SEXPTYPE z Complex => Sing SEXPTYPE z SString :: (~) SEXPTYPE z String => Sing SEXPTYPE z SDotDotDot :: (~) SEXPTYPE z DotDotDot => Sing SEXPTYPE z SAny :: (~) SEXPTYPE z Any => Sing SEXPTYPE z SVector :: (~) SEXPTYPE z Vector => Sing SEXPTYPE z SExpr :: (~) SEXPTYPE z Expr => Sing SEXPTYPE z SBytecode :: (~) SEXPTYPE z Bytecode => Sing SEXPTYPE z SExtPtr :: (~) SEXPTYPE z ExtPtr => Sing SEXPTYPE z SWeakRef :: (~) SEXPTYPE z WeakRef => Sing SEXPTYPE z SRaw :: (~) SEXPTYPE z Raw => Sing SEXPTYPE z SS4 :: (~) SEXPTYPE z S4 => Sing SEXPTYPE z SNew :: (~) SEXPTYPE z New => Sing SEXPTYPE z SFree :: (~) SEXPTYPE z Free => Sing SEXPTYPE z SFun :: (~) SEXPTYPE z Fun => Sing SEXPTYPE z Source
type DemoteRep SEXPTYPE (KProxy SEXPTYPE) = SEXPTYPE Source

type NilSym0 = Nil Source

type SymbolSym0 = Symbol Source

type ListSym0 = List Source

type ClosureSym0 = Closure Source

type EnvSym0 = Env Source

type PromiseSym0 = Promise Source

type LangSym0 = Lang Source

type SpecialSym0 = Special Source

type BuiltinSym0 = Builtin Source

type CharSym0 = Char Source

type LogicalSym0 = Logical Source

type IntSym0 = Int Source

type RealSym0 = Real Source

type ComplexSym0 = Complex Source

type StringSym0 = String Source

type DotDotDotSym0 = DotDotDot Source

type AnySym0 = Any Source

type VectorSym0 = Vector Source

type ExprSym0 = Expr Source

type BytecodeSym0 = Bytecode Source

type ExtPtrSym0 = ExtPtr Source

type WeakRefSym0 = WeakRef Source

type RawSym0 = Raw Source

type S4Sym0 = S4 Source

type NewSym0 = New Source

type FreeSym0 = Free Source

type FunSym0 = Fun Source

type SSEXPTYPE z = Sing z Source

data Logical Source

R uses three-valued logic.

Constructors

FALSE
TRUE
NA

Instances

Eq Logical Source
Methods (==) :: Logical -> Logical -> Bool (/=) :: Logical -> Logical -> Bool
Ord Logical Source
Methods compare :: Logical -> Logical -> Ordering (<) :: Logical -> Logical -> Bool (<=) :: Logical -> Logical -> Bool (>) :: Logical -> Logical -> Bool (>=) :: Logical -> Logical -> Bool max :: Logical -> Logical -> Logical min :: Logical -> Logical -> Logical
Show Logical Source
Methods showsPrec :: Int -> Logical -> ShowS show :: Logical -> String showList :: [Logical] -> ShowS
Storable Logical Source
Methods sizeOf :: Logical -> Int alignment :: Logical -> Int peekElemOff :: Ptr Logical -> Int -> IO Logical pokeElemOff :: Ptr Logical -> Int -> Logical -> IO () peekByteOff :: Ptr b -> Int -> IO Logical pokeByteOff :: Ptr b -> Int -> Logical -> IO () peek :: Ptr Logical -> IO Logical poke :: Ptr Logical -> Logical -> IO ()
Literal Logical Logical Source
Methods mkSEXPIO :: Logical -> IO (SEXP V Logical) Source fromSEXP :: SEXP s Logical -> Logical Source
Literal [Logical] Logical Source
Methods mkSEXPIO :: [Logical] -> IO (SEXP V Logical) Source fromSEXP :: SEXP s Logical -> [Logical] Source

type PairList = List Source

Used where the R documentation speaks of "pairlists", which are really just regular lists.

type IsVector a = (SingI a, a :∈ (Char ': (Logical ': (Int ': (Real ': (Complex ': (String ': (Vector ': (Expr ': (WeakRef ': (Raw ': '[]))))))))))) Source

Constraint synonym grouping all vector forms into one class. IsVector a holds iff R's is.vector() returns TRUE.

type IsGenericVector a = (SingI a, a :∈ '[Vector, Expr, WeakRef]) Source

Non-atomic vector forms. See src/main/memory.c:SET_VECTOR_ELT in the R source distribution.

type IsList a = (SingI a, a :∈ (Char ': (Logical ': (Int ': (Real ': (Complex ': (String ': (Vector ': (Expr ': (WeakRef ': (Raw ': (List ': '[])))))))))))) Source

IsList a holds iff R's is.list() returns TRUE.

type IsPairList a = (SingI a, a :∈ '[List, Nil]) Source

IsPairList a holds iff R's is.pairlist() returns TRUE.