InteractiveData.Core.Prelude
- Package
- purescript-interactive-data
- Repository
- thought2/purescript-interactive-data.all
Re-exports from Chameleon.Styled
#StyleT Source
newtype StyleT :: (Type -> Type) -> Type -> Typenewtype StyleT html a
Instances
FunctorTrans StyleT(Functor html) => Functor (StyleT html)(Html html) => Html (StyleT html)(Html html) => MapMaybe (StyleT html)(Html html) => HtmlStyled (StyleT html)(TellAccum acc html) => TellAccum acc (StyleT html)(Accum acc html) => Accum acc (StyleT html)(OutMsg out html) => OutMsg out (StyleT html)(RunOutMsg out html) => RunOutMsg out (StyleT html)
#HtmlStyled Source
class HtmlStyled :: (Type -> Type) -> Constraintclass (Html html) <= HtmlStyled (html :: Type -> Type) where
Members
registerStyleMap :: forall msg. StyleMap -> html msg -> html msg
Instances
(Html html) => HtmlStyled (StyleT html)(HtmlStyled html) => HtmlStyled (CtxT ctx html)
#styleKeyedNode Source
styleKeyedNode :: forall html style a. Html html => HtmlStyled html => IsStyle style => ElemKeyedNode html a -> style -> ElemKeyedNode html a#styleKeyedLeaf Source
styleKeyedLeaf :: forall html style a. Html html => HtmlStyled html => IsStyle style => ElemKeyedLeaf html a -> style -> ElemKeyedLeaf html aRe-exports from Chameleon.Transformers.Ctx.Class
Re-exports from Data.Either
#Either Source
data Either a bThe Either type is used to represent a choice between two types of value.
A common use case for Either is error handling, where Left is used to
carry an error value and Right is used to carry a success value.
Constructors
Instances
Functor (Either a)Generic (Either a b) _Invariant (Either a)Apply (Either e)The
Applyinstance allows functions contained within aRightto transform a value contained within aRightusing the(<*>)operator:Right f <*> Right x == Right (f x)Leftvalues are left untouched:Left f <*> Right x == Left f Right f <*> Left y == Left yCombining
Functor's<$>withApply's<*>can be used to transform a pure function to takeEither-typed arguments sof :: a -> b -> cbecomesf :: Either l a -> Either l b -> Either l c:f <$> Right x <*> Right y == Right (f x y)The
Left-preserving behaviour of both operators means the result of an expression like the above but where any one of the values isLeftmeans the whole result becomesLeftalso, taking the firstLeftvalue found:f <$> Left x <*> Right y == Left x f <$> Right x <*> Left y == Left y f <$> Left x <*> Left y == Left xApplicative (Either e)The
Applicativeinstance enables lifting of values intoEitherwith thepurefunction:pure x :: Either _ _ == Right xCombining
Functor's<$>withApply's<*>andApplicative'spurecan be used to pass a mixture ofEitherand non-Eithertyped values to a function that does not usually expect them, by usingpurefor any value that is not alreadyEithertyped:f <$> Right x <*> pure y == Right (f x y)Even though
pure = Rightit is recommended to usepurein situations like this as it allows the choice ofApplicativeto be changed later without having to go through and replaceRightwith a new constructor.Alt (Either e)The
Altinstance allows for a choice to be made between twoEithervalues with the<|>operator, where the firstRightencountered is taken.Right x <|> Right y == Right x Left x <|> Right y == Right y Left x <|> Left y == Left yBind (Either e)The
Bindinstance allows sequencing ofEithervalues and functions that return anEitherby using the>>=operator:Left x >>= f = Left x Right x >>= f = f xEither's "do notation" can be understood to work like this:x :: forall e a. Either e a x = -- y :: forall e b. Either e b y = -- foo :: forall e a. (a -> b -> c) -> Either e c foo f = do x' <- x y' <- y pure (f x' y')...which is equivalent to...
x >>= (\x' -> y >>= (\y' -> pure (f x' y')))...and is the same as writing...
foo :: forall e a. (a -> b -> c) -> Either e c foo f = case x of Left e -> Left e Right x -> case y of Left e -> Left e Right y -> Right (f x y)Monad (Either e)The
Monadinstance guarantees that there are bothApplicativeandBindinstances forEither.Extend (Either e)The
Extendinstance allows sequencing ofEithervalues and functions that accept anEitherand return a non-Eitherresult using the<<=operator.f <<= Left x = Left x f <<= Right x = Right (f (Right x))(Show a, Show b) => Show (Either a b)The
Showinstance allowsEithervalues to be rendered as a string withshowwhenever there is anShowinstance for both type theEithercan contain.(Eq a, Eq b) => Eq (Either a b)The
Eqinstance allowsEithervalues to be checked for equality with==and inequality with/=whenever there is anEqinstance for both types theEithercan contain.(Eq a) => Eq1 (Either a)(Ord a, Ord b) => Ord (Either a b)The
Ordinstance allowsEithervalues to be compared withcompare,>,>=,<and<=whenever there is anOrdinstance for both types theEithercan contain.Any
Leftvalue is considered to be less than aRightvalue.(Ord a) => Ord1 (Either a)(Bounded a, Bounded b) => Bounded (Either a b)(Semigroup b) => Semigroup (Either a b)
#fromRight' Source
fromRight' :: forall a b. (Unit -> b) -> Either a b -> bSimilar to fromRight but for use in cases where the default value may be
expensive to compute. As PureScript is not lazy, the standard fromRight
has to evaluate the default value before returning the result,
whereas here the value is only computed when the Either is known
to be Left.
#fromLeft' Source
fromLeft' :: forall a b. (Unit -> a) -> Either a b -> aSimilar to fromLeft but for use in cases where the default value may be
expensive to compute. As PureScript is not lazy, the standard fromLeft
has to evaluate the default value before returning the result,
whereas here the value is only computed when the Either is known
to be Right.
#either Source
either :: forall a b c. (a -> c) -> (b -> c) -> Either a b -> cTakes two functions and an Either value, if the value is a Left the
inner value is applied to the first function, if the value is a Right
the inner value is applied to the second function.
either f g (Left x) == f x
either f g (Right y) == g y
Re-exports from Data.Eq
#EqRecord Source
Re-exports from Data.Generic.Rep
#NoConstructors Source
newtype NoConstructorsA representation for types with no constructors.
#NoArguments Source
#Constructor Source
newtype Constructor :: Symbol -> Type -> Typenewtype Constructor (name :: Symbol) a
A representation for constructors which includes the data constructor name as a type-level string.
Constructors
Instances
(IsSymbol name, Show a) => Show (Constructor name a)
Re-exports from Data.Identity
#Identity Source
newtype Identity aConstructors
Identity a
Instances
Newtype (Identity a) _(Eq a) => Eq (Identity a)(Ord a) => Ord (Identity a)(Bounded a) => Bounded (Identity a)(HeytingAlgebra a) => HeytingAlgebra (Identity a)(BooleanAlgebra a) => BooleanAlgebra (Identity a)(Semigroup a) => Semigroup (Identity a)(Monoid a) => Monoid (Identity a)(Semiring a) => Semiring (Identity a)(EuclideanRing a) => EuclideanRing (Identity a)(Ring a) => Ring (Identity a)(CommutativeRing a) => CommutativeRing (Identity a)(Lazy a) => Lazy (Identity a)(Show a) => Show (Identity a)Eq1 IdentityOrd1 IdentityFunctor IdentityInvariant IdentityAlt IdentityApply IdentityApplicative IdentityBind IdentityMonad IdentityExtend IdentityComonad Identity
Re-exports from Data.Maybe
#Maybe Source
data Maybe aThe Maybe type is used to represent optional values and can be seen as
something like a type-safe null, where Nothing is null and Just x
is the non-null value x.
Constructors
Instances
Functor MaybeThe
Functorinstance allows functions to transform the contents of aJustwith the<$>operator:f <$> Just x == Just (f x)Nothingvalues are left untouched:f <$> Nothing == NothingApply MaybeThe
Applyinstance allows functions contained within aJustto transform a value contained within aJustusing theapplyoperator:Just f <*> Just x == Just (f x)Nothingvalues are left untouched:Just f <*> Nothing == Nothing Nothing <*> Just x == NothingCombining
Functor's<$>withApply's<*>can be used transform a pure function to takeMaybe-typed arguments sof :: a -> b -> cbecomesf :: Maybe a -> Maybe b -> Maybe c:f <$> Just x <*> Just y == Just (f x y)The
Nothing-preserving behaviour of both operators means the result of an expression like the above but where any one of the values isNothingmeans the whole result becomesNothingalso:f <$> Nothing <*> Just y == Nothing f <$> Just x <*> Nothing == Nothing f <$> Nothing <*> Nothing == NothingApplicative MaybeThe
Applicativeinstance enables lifting of values intoMaybewith thepurefunction:pure x :: Maybe _ == Just xCombining
Functor's<$>withApply's<*>andApplicative'spurecan be used to pass a mixture ofMaybeand non-Maybetyped values to a function that does not usually expect them, by usingpurefor any value that is not alreadyMaybetyped:f <$> Just x <*> pure y == Just (f x y)Even though
pure = Justit is recommended to usepurein situations like this as it allows the choice ofApplicativeto be changed later without having to go through and replaceJustwith a new constructor.Alt MaybeThe
Altinstance allows for a choice to be made between twoMaybevalues with the<|>operator, where the firstJustencountered is taken.Just x <|> Just y == Just x Nothing <|> Just y == Just y Nothing <|> Nothing == NothingPlus MaybeThe
Plusinstance provides a defaultMaybevalue:empty :: Maybe _ == NothingAlternative MaybeThe
Alternativeinstance guarantees that there are bothApplicativeandPlusinstances forMaybe.Bind MaybeThe
Bindinstance allows sequencing ofMaybevalues and functions that return aMaybeby using the>>=operator:Just x >>= f = f x Nothing >>= f = NothingMonad MaybeThe
Monadinstance guarantees that there are bothApplicativeandBindinstances forMaybe. This also enables thedosyntactic sugar:do x' <- x y' <- y pure (f x' y')Which is equivalent to:
x >>= (\x' -> y >>= (\y' -> pure (f x' y')))Which is equivalent to:
case x of Nothing -> Nothing Just x' -> case y of Nothing -> Nothing Just y' -> Just (f x' y')Extend MaybeThe
Extendinstance allows sequencing ofMaybevalues and functions that accept aMaybe aand return a non-Mayberesult using the<<=operator.f <<= Nothing = Nothing f <<= x = Just (f x)Invariant Maybe(Semigroup a) => Semigroup (Maybe a)The
Semigroupinstance enables use of the operator<>onMaybevalues whenever there is aSemigroupinstance for the type theMaybecontains. The exact behaviour of<>depends on the "inner"Semigroupinstance, but generally captures the notion of appending or combining things.Just x <> Just y = Just (x <> y) Just x <> Nothing = Just x Nothing <> Just y = Just y Nothing <> Nothing = Nothing(Semigroup a) => Monoid (Maybe a)(Semiring a) => Semiring (Maybe a)(Eq a) => Eq (Maybe a)The
Eqinstance allowsMaybevalues to be checked for equality with==and inequality with/=whenever there is anEqinstance for the type theMaybecontains.Eq1 Maybe(Ord a) => Ord (Maybe a)The
Ordinstance allowsMaybevalues to be compared withcompare,>,>=,<and<=whenever there is anOrdinstance for the type theMaybecontains.Nothingis considered to be less than anyJustvalue.Ord1 Maybe(Bounded a) => Bounded (Maybe a)(Show a) => Show (Maybe a)The
Showinstance allowsMaybevalues to be rendered as a string withshowwhenever there is anShowinstance for the type theMaybecontains.Generic (Maybe a) _
#optional Source
optional :: forall f a. Alt f => Applicative f => f a -> f (Maybe a)One or none.
optional empty = pure Nothing
The behaviour of optional (pure x) depends on whether the Alt instance
satisfy the left catch law (pure a <|> b = pure a).
Either e does:
optional (Right x) = Right (Just x)
But Array does not:
optional [x] = [Just x, Nothing]
#maybe' Source
maybe' :: forall a b. (Unit -> b) -> (a -> b) -> Maybe a -> bSimilar to maybe but for use in cases where the default value may be
expensive to compute. As PureScript is not lazy, the standard maybe has
to evaluate the default value before returning the result, whereas here
the value is only computed when the Maybe is known to be Nothing.
maybe' (\_ -> x) f Nothing == x
maybe' (\_ -> x) f (Just y) == f y
#maybe Source
maybe :: forall a b. b -> (a -> b) -> Maybe a -> bTakes a default value, a function, and a Maybe value. If the Maybe
value is Nothing the default value is returned, otherwise the function
is applied to the value inside the Just and the result is returned.
maybe x f Nothing == x
maybe x f (Just y) == f y
#fromMaybe' Source
fromMaybe' :: forall a. (Unit -> a) -> Maybe a -> aSimilar to fromMaybe but for use in cases where the default value may be
expensive to compute. As PureScript is not lazy, the standard fromMaybe
has to evaluate the default value before returning the result, whereas here
the value is only computed when the Maybe is known to be Nothing.
fromMaybe' (\_ -> x) Nothing == x
fromMaybe' (\_ -> x) (Just y) == y
Re-exports from Data.Newtype
#Newtype Source
class (Coercible t a) <= Newtype t a | t -> aA type class for newtypes to enable convenient wrapping and unwrapping,
and the use of the other functions in this module.
The compiler can derive instances of Newtype automatically:
newtype EmailAddress = EmailAddress String
derive instance newtypeEmailAddress :: Newtype EmailAddress _
Note that deriving for Newtype instances requires that the type be
defined as newtype rather than data declaration (even if the data
structurally fits the rules of a newtype), and the use of a wildcard for
the wrapped type.
Instances
Re-exports from Data.Ord
#OrdRecord Source
#signum Source
signum :: forall a. Ord a => Ring a => a -> aThe sign function; returns one if the argument is positive,
negate one if the argument is negative, or zero if the argument is zero.
For floating point numbers with signed zeroes, when called with a zero,
this function returns the argument in order to preserve the sign.
For any x, we should have signum x * abs x == x.
#lessThanOrEq Source
lessThanOrEq :: forall a. Ord a => a -> a -> BooleanTest whether one value is non-strictly less than another.
#greaterThanOrEq Source
greaterThanOrEq :: forall a. Ord a => a -> a -> BooleanTest whether one value is non-strictly greater than another.
#greaterThan Source
greaterThan :: forall a. Ord a => a -> a -> BooleanTest whether one value is strictly greater than another.
Re-exports from Data.Show.Generic
#GenericShow Source
class GenericShow a whereMembers
genericShow' :: a -> String
Instances
GenericShow NoConstructors(GenericShow a, GenericShow b) => GenericShow (Sum a b)(GenericShowArgs a, IsSymbol name) => GenericShow (Constructor name a)
#GenericShowArgs Source
class GenericShowArgs a whereMembers
genericShowArgs :: a -> Array String
Instances
GenericShowArgs NoArguments(GenericShowArgs a, GenericShowArgs b) => GenericShowArgs (Product a b)(Show a) => GenericShowArgs (Argument a)
#genericShow Source
genericShow :: forall a rep. Generic a rep => GenericShow rep => a -> StringA Generic implementation of the show member from the Show type class.
Re-exports from Data.These
#These Source
data These a bData type isomorphic to α ∨ β ∨ (α ∧ β) or
Either a (Either b (Tuple a b)).
Constructors
Instances
(Eq a, Eq b) => Eq (These a b)(Ord a, Ord b) => Ord (These a b)(Semigroup a, Semigroup b) => Semigroup (These a b)Functor (These a)Invariant (These a)Foldable (These a)Traversable (These a)Bifunctor TheseBifoldable TheseBitraversable These(Semigroup a) => Apply (These a)(Semigroup a) => Applicative (These a)(Semigroup a) => Bind (These a)(Semigroup a) => Monad (These a)Extend (These a)(Show a, Show b) => Show (These a b)
#thisOrBoth Source
thisOrBoth :: forall a b. a -> Maybe b -> These a b#theseRight Source
theseRight :: forall a b. These a b -> Maybe bReturns a b value if possible.
#thatOrBoth Source
thatOrBoth :: forall a b. b -> Maybe a -> These a b#maybeThese Source
maybeThese :: forall a b. Maybe a -> Maybe b -> Maybe (These a b)Takes a pair of Maybes and attempts to create a These from them.
#fromThese Source
fromThese :: forall a b. a -> b -> These a b -> Tuple a bTakes two default values and a These value. If the These value is
This or That, the value wrapped in the These value and its
corresponding default value are wrapped into a Tuple.
Otherwise, the values stored in the Both are rewrapped into a Tuple.
Re-exports from Data.Tuple.Nested
#(/\) Source
Operator alias for Data.Tuple.Tuple (right-associative / precedence 6)
Shorthand for constructing n-tuples as nested pairs.
a /\ b /\ c /\ d /\ unit becomes Tuple a (Tuple b (Tuple c (Tuple d unit)))
#type (/\) Source
Operator alias for Data.Tuple.Tuple (right-associative / precedence 6)
Shorthand for constructing n-tuple types as nested pairs.
forall a b c d. a /\ b /\ c /\ d /\ Unit becomes
forall a b c d. Tuple a (Tuple b (Tuple c (Tuple d Unit)))
Re-exports from DataMVC.Types
#DataUiInterface Source
newtype DataUiInterface :: (Type -> Type) -> Type -> Type -> Type -> Typenewtype DataUiInterface srf msg sta a
Constructors
DataUiInterface { extract :: sta -> DataResult a, init :: Maybe a -> sta, name :: String, update :: msg -> sta -> sta, view :: sta -> srf msg }
Instances
Newtype (DataUiInterface srf msg sta a) _
#DataResult Source
type DataResult a = Either (NonEmptyArray DataError) a#DataPathSegment Source
#DataPath Source
type DataPath = Array DataPathSegment#DataErrorCase Source
Re-exports from DataMVC.Types.DataError
Re-exports from InteractiveData.Core
#PathInContext Source
type PathInContext a = { before :: Array a, path :: Array a }#IDSurfaceCtx Source
type IDSurfaceCtx = { path :: DataPath }#DataTreeChildren Source
data DataTreeChildren :: (Type -> Type) -> Type -> Typedata DataTreeChildren srf msg
Constructors
Instances
(Functor srf) => Functor (DataTreeChildren srf)(Eq1 srf, Eq (srf msg), Eq msg) => Eq (DataTreeChildren srf msg)(Ord (srf msg), Ord1 srf, Ord msg) => Ord (DataTreeChildren srf msg)
#DataTree Source
#DataAction Source
newtype DataAction msgConstructors
DataAction { description :: String, label :: String, msg :: These msg IDOutMsg }
Instances
Functor DataAction(Eq msg) => Eq (DataAction msg)(Ord msg) => Ord (DataAction msg)
Re-exports from InteractiveData.Core.Classes.OptArgs
#OptArgs Source
class OptArgs all given whereMembers
getAllArgs :: all -> given -> all
Instances
(ConvertOptionsWithDefaults NoConvert all given all) => OptArgs all given
#OptArgsMixed Source
class OptArgsMixed :: Type -> Row Type -> Type -> Constraintclass OptArgsMixed all defaults given | all -> defaults given where
Members
getAllArgsMixed :: Record defaults -> given -> all
Instances
(ConvertOptionsWithDefaults NoConvert (Record defaults) given all) => OptArgsMixed all defaults given
Re-exports from InteractiveData.Core.Util.RecordProjection
Re-exports from Prelude
#Void Source
newtype VoidAn uninhabited data type. In other words, one can never create
a runtime value of type Void because no such value exists.
Void is useful to eliminate the possibility of a value being created.
For example, a value of type Either Void Boolean can never have
a Left value created in PureScript.
This should not be confused with the keyword void that commonly appears in
C-family languages, such as Java:
public class Foo {
void doSomething() { System.out.println("hello world!"); }
}
In PureScript, one often uses Unit to achieve similar effects as
the void of C-family languages above.
#Unit Source
data UnitThe Unit type has a single inhabitant, called unit. It represents
values with no computational content.
Unit is often used, wrapped in a monadic type constructor, as the
return type of a computation where only the effects are important.
When returning a value of type Unit from an FFI function, it is
recommended to use undefined, or not return a value at all.
#Ordering Source
data OrderingThe Ordering data type represents the three possible outcomes of
comparing two values:
LT - The first value is less than the second.
GT - The first value is greater than the second.
EQ - The first value is equal to the second.
Constructors
Instances
#Applicative Source
class Applicative :: (Type -> Type) -> Constraintclass (Apply f) <= Applicative f where
The Applicative type class extends the Apply type class
with a pure function, which can be used to create values of type f a
from values of type a.
Where Apply provides the ability to lift functions of two or
more arguments to functions whose arguments are wrapped using f, and
Functor provides the ability to lift functions of one
argument, pure can be seen as the function which lifts functions of
zero arguments. That is, Applicative functors support a lifting
operation for any number of function arguments.
Instances must satisfy the following laws in addition to the Apply
laws:
- Identity:
(pure identity) <*> v = v - Composition:
pure (<<<) <*> f <*> g <*> h = f <*> (g <*> h) - Homomorphism:
(pure f) <*> (pure x) = pure (f x) - Interchange:
u <*> (pure y) = (pure (_ $ y)) <*> u
Members
pure :: forall a. a -> f a
Instances
#Apply Source
class Apply :: (Type -> Type) -> Constraintclass (Functor f) <= Apply f where
The Apply class provides the (<*>) which is used to apply a function
to an argument under a type constructor.
Apply can be used to lift functions of two or more arguments to work on
values wrapped with the type constructor f. It might also be understood
in terms of the lift2 function:
lift2 :: forall f a b c. Apply f => (a -> b -> c) -> f a -> f b -> f c
lift2 f a b = f <$> a <*> b
(<*>) is recovered from lift2 as lift2 ($). That is, (<*>) lifts
the function application operator ($) to arguments wrapped with the
type constructor f.
Put differently...
foo =
functionTakingNArguments <$> computationProducingArg1
<*> computationProducingArg2
<*> ...
<*> computationProducingArgN
Instances must satisfy the following law in addition to the Functor
laws:
- Associative composition:
(<<<) <$> f <*> g <*> h = f <*> (g <*> h)
Formally, Apply represents a strong lax semi-monoidal endofunctor.
Members
apply :: forall a b. f (a -> b) -> f a -> f b
Instances
#Bind Source
class Bind :: (Type -> Type) -> Constraintclass (Apply m) <= Bind m where
The Bind type class extends the Apply type class with a
"bind" operation (>>=) which composes computations in sequence, using
the return value of one computation to determine the next computation.
The >>= operator can also be expressed using do notation, as follows:
x >>= f = do y <- x
f y
where the function argument of f is given the name y.
Instances must satisfy the following laws in addition to the Apply
laws:
- Associativity:
(x >>= f) >>= g = x >>= (\k -> f k >>= g) - Apply Superclass:
apply f x = f >>= \f’ -> map f’ x
Associativity tells us that we can regroup operations which use do
notation so that we can unambiguously write, for example:
do x <- m1
y <- m2 x
m3 x y
Members
bind :: forall a b. m a -> (a -> m b) -> m b
Instances
Bind (Function r)Bind ArrayThe
bind/>>=function forArrayworks by applying a function to each element in the array, and flattening the results into a single, new array.Array's
bind/>>=works like a nested for loop. Eachbindadds another level of nesting in the loop. For example:foo :: Array String foo = ["a", "b"] >>= \eachElementInArray1 -> ["c", "d"] >>= \eachElementInArray2 pure (eachElementInArray1 <> eachElementInArray2) -- In other words... foo -- ... is the same as... [ ("a" <> "c"), ("a" <> "d"), ("b" <> "c"), ("b" <> "d") ] -- which simplifies to... [ "ac", "ad", "bc", "bd" ]Bind Proxy
#BooleanAlgebra Source
class (HeytingAlgebra a) <= BooleanAlgebra a The BooleanAlgebra type class represents types that behave like boolean
values.
Instances should satisfy the following laws in addition to the
HeytingAlgebra law:
- Excluded middle:
a || not a = tt
Instances
BooleanAlgebra BooleanBooleanAlgebra Unit(BooleanAlgebra b) => BooleanAlgebra (a -> b)(RowToList row list, BooleanAlgebraRecord list row row) => BooleanAlgebra (Record row)BooleanAlgebra (Proxy a)
#Bounded Source
class (Ord a) <= Bounded a whereThe Bounded type class represents totally ordered types that have an
upper and lower boundary.
Instances should satisfy the following law in addition to the Ord laws:
- Bounded:
bottom <= a <= top
Members
Instances
Bounded BooleanBounded IntThe
BoundedIntinstance hastop :: Intequal to 2^31 - 1, andbottom :: Intequal to -2^31, since these are the largest and smallest integers representable by twos-complement 32-bit integers, respectively.Bounded CharCharacters fall within the Unicode range.
Bounded OrderingBounded UnitBounded NumberBounded (Proxy a)(RowToList row list, BoundedRecord list row row) => Bounded (Record row)
#Category Source
class Category :: forall k. (k -> k -> Type) -> Constraintclass (Semigroupoid a) <= Category a where
Categorys consist of objects and composable morphisms between them, and
as such are Semigroupoids, but unlike semigroupoids
must have an identity element.
Instances must satisfy the following law in addition to the
Semigroupoid law:
- Identity:
identity <<< p = p <<< identity = p
Members
identity :: forall t. a t t
Instances
#CommutativeRing Source
class (Ring a) <= CommutativeRing a The CommutativeRing class is for rings where multiplication is
commutative.
Instances must satisfy the following law in addition to the Ring
laws:
- Commutative multiplication:
a * b = b * a
Instances
CommutativeRing IntCommutativeRing NumberCommutativeRing Unit(CommutativeRing b) => CommutativeRing (a -> b)(RowToList row list, CommutativeRingRecord list row row) => CommutativeRing (Record row)CommutativeRing (Proxy a)
#DivisionRing Source
class (Ring a) <= DivisionRing a whereThe DivisionRing class is for non-zero rings in which every non-zero
element has a multiplicative inverse. Division rings are sometimes also
called skew fields.
Instances must satisfy the following laws in addition to the Ring laws:
- Non-zero ring:
one /= zero - Non-zero multiplicative inverse:
recip a * a = a * recip a = onefor all non-zeroa
The result of recip zero is left undefined; individual instances may
choose how to handle this case.
If a type has both DivisionRing and CommutativeRing instances, then
it is a field and should have a Field instance.
Members
recip :: a -> a
Instances
#Eq Source
class Eq a whereThe Eq type class represents types which support decidable equality.
Eq instances should satisfy the following laws:
- Reflexivity:
x == x = true - Symmetry:
x == y = y == x - Transitivity: if
x == yandy == zthenx == z
Note: The Number type is not an entirely law abiding member of this
class due to the presence of NaN, since NaN /= NaN. Additionally,
computing with Number can result in a loss of precision, so sometimes
values that should be equivalent are not.
Members
Instances
#EuclideanRing Source
class (CommutativeRing a) <= EuclideanRing a whereThe EuclideanRing class is for commutative rings that support division.
The mathematical structure this class is based on is sometimes also called
a Euclidean domain.
Instances must satisfy the following laws in addition to the Ring
laws:
- Integral domain:
one /= zero, and ifaandbare both nonzero then so is their producta * b - Euclidean function
degree:- Nonnegativity: For all nonzero
a,degree a >= 0 - Quotient/remainder: For all
aandb, wherebis nonzero, letq = a / bandr = a `mod` b; thena = q*b + r, and also eitherr = zeroordegree r < degree b
- Nonnegativity: For all nonzero
- Submultiplicative euclidean function:
- For all nonzero
aandb,degree a <= degree (a * b)
- For all nonzero
The behaviour of division by zero is unconstrained by these laws,
meaning that individual instances are free to choose how to behave in this
case. Similarly, there are no restrictions on what the result of
degree zero is; it doesn't make sense to ask for degree zero in the
same way that it doesn't make sense to divide by zero, so again,
individual instances may choose how to handle this case.
For any EuclideanRing which is also a Field, one valid choice
for degree is simply const 1. In fact, unless there's a specific
reason not to, Field types should normally use this definition of
degree.
The EuclideanRing Int instance is one of the most commonly used
EuclideanRing instances and deserves a little more discussion. In
particular, there are a few different sensible law-abiding implementations
to choose from, with slightly different behaviour in the presence of
negative dividends or divisors. The most common definitions are "truncating"
division, where the result of a / b is rounded towards 0, and "Knuthian"
or "flooring" division, where the result of a / b is rounded towards
negative infinity. A slightly less common, but arguably more useful, option
is "Euclidean" division, which is defined so as to ensure that a `mod` b
is always nonnegative. With Euclidean division, a / b rounds towards
negative infinity if the divisor is positive, and towards positive infinity
if the divisor is negative. Note that all three definitions are identical if
we restrict our attention to nonnegative dividends and divisors.
In versions 1.x, 2.x, and 3.x of the Prelude, the EuclideanRing Int
instance used truncating division. As of 4.x, the EuclideanRing Int
instance uses Euclidean division. Additional functions quot and rem are
supplied if truncating division is desired.
Members
Instances
#Field Source
class (EuclideanRing a, DivisionRing a) <= Field a The Field class is for types that are (commutative) fields.
Mathematically, a field is a ring which is commutative and in which every
nonzero element has a multiplicative inverse; these conditions correspond
to the CommutativeRing and DivisionRing classes in PureScript
respectively. However, the Field class has EuclideanRing and
DivisionRing as superclasses, which seems like a stronger requirement
(since CommutativeRing is a superclass of EuclideanRing). In fact, it
is not stronger, since any type which has law-abiding CommutativeRing
and DivisionRing instances permits exactly one law-abiding
EuclideanRing instance. We use a EuclideanRing superclass here in
order to ensure that a Field constraint on a function permits you to use
div on that type, since div is a member of EuclideanRing.
This class has no laws or members of its own; it exists as a convenience, so a single constraint can be used when field-like behaviour is expected.
This module also defines a single Field instance for any type which has
both EuclideanRing and DivisionRing instances. Any other instance
would overlap with this instance, so no other Field instances should be
defined in libraries. Instead, simply define EuclideanRing and
DivisionRing instances, and this will permit your type to be used with a
Field constraint.
Instances
(EuclideanRing a, DivisionRing a) => Field a
#Functor Source
class Functor :: (Type -> Type) -> Constraintclass Functor f where
A Functor is a type constructor which supports a mapping operation
map.
map can be used to turn functions a -> b into functions
f a -> f b whose argument and return types use the type constructor f
to represent some computational context.
Instances must satisfy the following laws:
- Identity:
map identity = identity - Composition:
map (f <<< g) = map f <<< map g
Members
map :: forall a b. (a -> b) -> f a -> f b
Instances
#HeytingAlgebra Source
class HeytingAlgebra a whereThe HeytingAlgebra type class represents types that are bounded lattices with
an implication operator such that the following laws hold:
- Associativity:
a || (b || c) = (a || b) || ca && (b && c) = (a && b) && c
- Commutativity:
a || b = b || aa && b = b && a
- Absorption:
a || (a && b) = aa && (a || b) = a
- Idempotent:
a || a = aa && a = a
- Identity:
a || ff = aa && tt = a
- Implication:
a `implies` a = tta && (a `implies` b) = a && bb && (a `implies` b) = ba `implies` (b && c) = (a `implies` b) && (a `implies` c)
- Complemented:
not a = a `implies` ff
Members
Instances
HeytingAlgebra BooleanHeytingAlgebra Unit(HeytingAlgebra b) => HeytingAlgebra (a -> b)HeytingAlgebra (Proxy a)(RowToList row list, HeytingAlgebraRecord list row row) => HeytingAlgebra (Record row)
#Monad Source
class Monad :: (Type -> Type) -> Constraintclass (Applicative m, Bind m) <= Monad m
The Monad type class combines the operations of the Bind and
Applicative type classes. Therefore, Monad instances represent type
constructors which support sequential composition, and also lifting of
functions of arbitrary arity.
Instances must satisfy the following laws in addition to the
Applicative and Bind laws:
- Left Identity:
pure x >>= f = f x - Right Identity:
x >>= pure = x
Instances
#Monoid Source
class (Semigroup m) <= Monoid m whereA Monoid is a Semigroup with a value mempty, which is both a
left and right unit for the associative operation <>:
- Left unit:
(mempty <> x) = x - Right unit:
(x <> mempty) = x
Monoids are commonly used as the result of fold operations, where
<> is used to combine individual results, and mempty gives the result
of folding an empty collection of elements.
Newtypes for Monoid
Some types (e.g. Int, Boolean) can implement multiple law-abiding
instances for Monoid. Let's use Int as an example
<>could be+andmemptycould be0<>could be*andmemptycould be1.
To clarify these ambiguous situations, one should use the newtypes
defined in Data.Monoid.<NewtypeName> modules.
In the above ambiguous situation, we could use Additive
for the first situation or Multiplicative for the second one.
Members
mempty :: m
Instances
#Ord Source
class (Eq a) <= Ord a whereThe Ord type class represents types which support comparisons with a
total order.
Ord instances should satisfy the laws of total orderings:
- Reflexivity:
a <= a - Antisymmetry: if
a <= bandb <= athena == b - Transitivity: if
a <= bandb <= cthena <= c
Note: The Number type is not an entirely law abiding member of this
class due to the presence of NaN, since NaN <= NaN evaluates to false
Members
Instances
#Ring Source
class (Semiring a) <= Ring a whereThe Ring class is for types that support addition, multiplication,
and subtraction operations.
Instances must satisfy the following laws in addition to the Semiring
laws:
- Additive inverse:
a - a = zero - Compatibility of
subandnegate:a - b = a + (zero - b)
Members
sub :: a -> a -> a
Instances
#Semigroup Source
class Semigroup a whereThe Semigroup type class identifies an associative operation on a type.
Instances are required to satisfy the following law:
- Associativity:
(x <> y) <> z = x <> (y <> z)
One example of a Semigroup is String, with (<>) defined as string
concatenation. Another example is List a, with (<>) defined as
list concatenation.
Newtypes for Semigroup
There are two other ways to implement an instance for this type class regardless of which type is used. These instances can be used by wrapping the values in one of the two newtypes below:
First- Use the first argument every time:append first _ = first.Last- Use the last argument every time:append _ last = last.
Members
append :: a -> a -> a
Instances
#Semigroupoid Source
class Semigroupoid :: forall k. (k -> k -> Type) -> Constraintclass Semigroupoid a where
A Semigroupoid is similar to a Category but does not
require an identity element identity, just composable morphisms.
Semigroupoids must satisfy the following law:
- Associativity:
p <<< (q <<< r) = (p <<< q) <<< r
One example of a Semigroupoid is the function type constructor (->),
with (<<<) defined as function composition.
Members
compose :: forall b c d. a c d -> a b c -> a b d
Instances
#Semiring Source
class Semiring a whereThe Semiring class is for types that support an addition and
multiplication operation.
Instances must satisfy the following laws:
- Commutative monoid under addition:
- Associativity:
(a + b) + c = a + (b + c) - Identity:
zero + a = a + zero = a - Commutative:
a + b = b + a
- Associativity:
- Monoid under multiplication:
- Associativity:
(a * b) * c = a * (b * c) - Identity:
one * a = a * one = a
- Associativity:
- Multiplication distributes over addition:
- Left distributivity:
a * (b + c) = (a * b) + (a * c) - Right distributivity:
(a + b) * c = (a * c) + (b * c)
- Left distributivity:
- Annihilation:
zero * a = a * zero = zero
Note: The Number and Int types are not fully law abiding
members of this class hierarchy due to the potential for arithmetic
overflows, and in the case of Number, the presence of NaN and
Infinity values. The behaviour is unspecified in these cases.
Members
Instances
#Show Source
class Show a whereThe Show type class represents those types which can be converted into
a human-readable String representation.
While not required, it is recommended that for any expression x, the
string show x be executable PureScript code which evaluates to the same
value as the expression x.
Members
Instances
#when Source
when :: forall m. Applicative m => Boolean -> m Unit -> m UnitPerform an applicative action when a condition is true.
#void Source
void :: forall f a. Functor f => f a -> f UnitThe void function is used to ignore the type wrapped by a
Functor, replacing it with Unit and keeping only the type
information provided by the type constructor itself.
void is often useful when using do notation to change the return type
of a monadic computation:
main = forE 1 10 \n -> void do
print n
print (n * n)
#unless Source
unless :: forall m. Applicative m => Boolean -> m Unit -> m UnitPerform an applicative action unless a condition is true.
#liftM1 Source
liftM1 :: forall m a b. Monad m => (a -> b) -> m a -> m bliftM1 provides a default implementation of (<$>) for any
Monad, without using (<$>) as provided by the
Functor-Monad superclass relationship.
liftM1 can therefore be used to write Functor instances
as follows:
instance functorF :: Functor F where
map = liftM1
#liftA1 Source
liftA1 :: forall f a b. Applicative f => (a -> b) -> f a -> f bliftA1 provides a default implementation of (<$>) for any
Applicative functor, without using (<$>) as provided
by the Functor-Applicative superclass
relationship.
liftA1 can therefore be used to write Functor instances
as follows:
instance functorF :: Functor F where
map = liftA1
#lcm Source
lcm :: forall a. Eq a => EuclideanRing a => a -> a -> aThe least common multiple of two values.
#gcd Source
gcd :: forall a. Eq a => EuclideanRing a => a -> a -> aThe greatest common divisor of two values.
#flip Source
flip :: forall a b c. (a -> b -> c) -> b -> a -> cGiven a function that takes two arguments, applies the arguments to the function in a swapped order.
flip append "1" "2" == append "2" "1" == "21"
const 1 "two" == 1
flip const 1 "two" == const "two" 1 == "two"
#flap Source
flap :: forall f a b. Functor f => f (a -> b) -> a -> f bApply a value in a computational context to a value in no context.
Generalizes flip.
longEnough :: String -> Bool
hasSymbol :: String -> Bool
hasDigit :: String -> Bool
password :: String
validate :: String -> Array Bool
validate = flap [longEnough, hasSymbol, hasDigit]
flap (-) 3 4 == 1
threeve <$> Just 1 <@> 'a' <*> Just true == Just (threeve 1 'a' true)
#const Source
const :: forall a b. a -> b -> aReturns its first argument and ignores its second.
const 1 "hello" = 1
It can also be thought of as creating a function that ignores its argument:
const 1 = \_ -> 1
#(>>>) Source
Operator alias for Control.Semigroupoid.composeFlipped (right-associative / precedence 9)
#(<=<) Source
Operator alias for Control.Bind.composeKleisliFlipped (right-associative / precedence 1)
#($) Source
Operator alias for Data.Function.apply (right-associative / precedence 0)
Applies a function to an argument: the reverse of (#).
length $ groupBy productCategory $ filter isInStock $ products
is equivalent to:
length (groupBy productCategory (filter isInStock products))
Or another alternative equivalent, applying chain of composed functions to a value:
length <<< groupBy productCategory <<< filter isInStock $ products
#(#) Source
Operator alias for Data.Function.applyFlipped (left-associative / precedence 1)
Applies an argument to a function: the reverse of ($).
products # filter isInStock # groupBy productCategory # length
is equivalent to:
length (groupBy productCategory (filter isInStock products))
Or another alternative equivalent, applying a value to a chain of composed functions:
products # filter isInStock >>> groupBy productCategory >>> length
#type (~>) Source
Operator alias for Data.NaturalTransformation.NaturalTransformation (right-associative / precedence 4)
Re-exports from Type.Row
#Cons
#Lacks
#Nub
#Union
#type (+) Source
Operator alias for Type.Row.RowApply (right-associative / precedence 0)
Applies a type alias of open rows to a set of rows. The primary use case this operator is as convenient sugar for combining open rows without parentheses.
type Rows1 r = (a :: Int, b :: String | r)
type Rows2 r = (c :: Boolean | r)
type Rows3 r = (Rows1 + Rows2 + r)
type Rows4 r = (d :: String | Rows1 + Rows2 + r)
- Modules
- InteractiveData
- InteractiveData.
App - InteractiveData.
App. EnvVars - InteractiveData.
App. FastForward. Inline - InteractiveData.
App. FastForward. Standalone - InteractiveData.
App. Routing - InteractiveData.
App. Types - InteractiveData.
App. UI. ActionButton - InteractiveData.
App. UI. Assets - InteractiveData.
App. UI. Body - InteractiveData.
App. UI. Breadcrumbs - InteractiveData.
App. UI. Card - InteractiveData.
App. UI. DataLabel - InteractiveData.
App. UI. Footer - InteractiveData.
App. UI. Header - InteractiveData.
App. UI. Layout - InteractiveData.
App. UI. Menu - InteractiveData.
App. UI. NotFound - InteractiveData.
App. UI. SideBar - InteractiveData.
App. UI. Types. SumTree - InteractiveData.
App. WrapApp - InteractiveData.
App. WrapData - InteractiveData.
Class - InteractiveData.
Class. Defaults - InteractiveData.
Class. Defaults. Generic - InteractiveData.
Class. Defaults. Record - InteractiveData.
Class. Defaults. Variant - InteractiveData.
Class. InitDataUI - InteractiveData.
Class. Partial - InteractiveData.
Core - InteractiveData.
Core. Classes. IDHtml - InteractiveData.
Core. Classes. OptArgs - InteractiveData.
Core. FeatureFlags - InteractiveData.
Core. Prelude - InteractiveData.
Core. Types. Common - InteractiveData.
Core. Types. DataAction - InteractiveData.
Core. Types. DataPathExtra - InteractiveData.
Core. Types. DataTree - InteractiveData.
Core. Types. IDHtmlT - InteractiveData.
Core. Types. IDOutMsg - InteractiveData.
Core. Types. IDSurface - InteractiveData.
Core. Types. IDViewCtx - InteractiveData.
Core. Util. RecordProjection - InteractiveData.
DataUIs - InteractiveData.
DataUIs. Array - InteractiveData.
DataUIs. Boolean - InteractiveData.
DataUIs. Common - InteractiveData.
DataUIs. Generic - InteractiveData.
DataUIs. Int - InteractiveData.
DataUIs. Json - InteractiveData.
DataUIs. Newtype - InteractiveData.
DataUIs. Number - InteractiveData.
DataUIs. Record - InteractiveData.
DataUIs. String - InteractiveData.
DataUIs. Trivial - InteractiveData.
DataUIs. Types - InteractiveData.
DataUIs. Variant - InteractiveData.
Entry - InteractiveData.
Run - InteractiveData.
UI. NumberInput - InteractiveData.
UI. Slider
The
Functorinstance allows functions to transform the contents of aRightwith the<$>operator:Leftvalues are untouched: