NumHask.Space.Types

Documentation

class Space s where

Minimal complete definition

lower, upper, (>.<)

Associated Types

type Element s :: *

the underlying element in the space

Methods

lower :: s -> Element s

lower boundary

upper :: s -> Element s

upper boundary

singleton :: Element s -> s

space containing a single element

intersection :: s -> s -> s

the intersection of two spaces

intersection :: Ord (Element s) => s -> s -> s

the intersection of two spaces

union :: s -> s -> s

the union of two spaces

union :: Ord (Element s) => s -> s -> s

the union of two spaces

norm :: s -> s

Normalise a space so that > lower a / upper a == lower a > lower a / upper a == upper a

(...) :: Element s -> Element s -> s infix 3

create a normalised space from two elements

(...) :: Ord (Element s) => Element s -> Element s -> s infix 3

create a normalised space from two elements

(>.<) :: Element s -> Element s -> s infix 3

create a space from two elements without normalising

(|.|) :: Element s -> s -> Bool infixl 7

is an element in the space

(|.|) :: Ord (Element s) => Element s -> s -> Bool infixl 7

is an element in the space

(|>|) :: s -> s -> Bool infixl 7

is one space completely above the other

(|>|) :: Ord (Element s) => s -> s -> Bool infixl 7

is one space completely above the other

(|<|) :: s -> s -> Bool infixl 7

is one space completely below the other

(|<|) :: Ord (Element s) => s -> s -> Bool infixl 7

is one space completely below the other

Instances

(Eq a, Ord a) => Space (Range a)

Defined in NumHask.Range

Associated Types

type Element (Range a) :: Type

Methods

lower :: Range a -> Element (Range a)

upper :: Range a -> Element (Range a)

singleton :: Element (Range a) -> Range a

intersection :: Range a -> Range a -> Range a

union :: Range a -> Range a -> Range a

norm :: Range a -> Range a

(...) :: Element (Range a) -> Element (Range a) -> Range a

(>.<) :: Element (Range a) -> Element (Range a) -> Range a

(|.|) :: Element (Range a) -> Range a -> Bool

(|>|) :: Range a -> Range a -> Bool

(|<|) :: Range a -> Range a -> Bool

Ord a => Space (Rect a)

Defined in NumHask.Rect

Associated Types

type Element (Rect a) :: Type

Methods

lower :: Rect a -> Element (Rect a)

upper :: Rect a -> Element (Rect a)

singleton :: Element (Rect a) -> Rect a

intersection :: Rect a -> Rect a -> Rect a

union :: Rect a -> Rect a -> Rect a

norm :: Rect a -> Rect a

(...) :: Element (Rect a) -> Element (Rect a) -> Rect a

(>.<) :: Element (Rect a) -> Element (Rect a) -> Rect a

(|.|) :: Element (Rect a) -> Rect a -> Bool

(|>|) :: Rect a -> Rect a -> Bool

(|<|) :: Rect a -> Rect a -> Bool

newtype Union a

Constructors

Union

Fields

• getUnion :: a

Instances

Space a => Semigroup (Union a)

Defined in NumHask.Space.Types

Methods

(<>) :: Union a -> Union a -> Union a

sconcat :: NonEmpty (Union a) -> Union a

stimes :: Integral b => b -> Union a -> Union a

newtype Intersection a

Constructors

Intersection

Fields

• getIntersection :: a

Instances

Space a => Semigroup (Intersection a)

Defined in NumHask.Space.Types

Methods

(<>) :: Intersection a -> Intersection a -> Intersection a

sconcat :: NonEmpty (Intersection a) -> Intersection a

stimes :: Integral b => b -> Intersection a -> Intersection a

class (Space s, Num (Element s)) => FieldSpace s where

a space that can be divided neatly

Associated Types

type Grid s :: *

Methods

grid :: Pos -> s -> Grid s -> [Element s]

create equally-spaced elements across a space

gridSpace :: s -> Grid s -> [s]

create equally-spaced spaces from a space

Instances

(Ord a, Fractional a) => FieldSpace (Range a)

Defined in NumHask.Range

Associated Types

type Grid (Range a) :: Type

Methods

grid :: Pos -> Range a -> Grid (Range a) -> [Element (Range a)]

gridSpace :: Range a -> Grid (Range a) -> [Range a]

(Ord a, Fractional a, Num a) => FieldSpace (Rect a)

Defined in NumHask.Rect

Associated Types

type Grid (Rect a) :: Type

Methods

grid :: Pos -> Rect a -> Grid (Rect a) -> [Element (Rect a)]

gridSpace :: Rect a -> Grid (Rect a) -> [Rect a]

mid :: (Space s, Fractional (Element s)) => s -> Element s

mid-point of the space

project :: (Space s, Fractional (Element s)) => s -> s -> Element s -> Element s

project a data point from one space to another, preserving relative position

project o n (lower o) = lower n
project o n (upper o) = upper n
project a a x = x
project mempty one zero = NaN
project one mempty zero = Infinity
project one mempty one = NaN

data Pos

Pos suggests where points should be placed in forming a grid across a field space.

Constructors

OuterPos

InnerPos

LowerPos

UpperPos

MidPos

Instances

Eq Pos

Defined in NumHask.Space.Types

Methods

(==) :: Pos -> Pos -> Bool

(/=) :: Pos -> Pos -> Bool

Show Pos

Defined in NumHask.Space.Types

Methods

showsPrec :: Int -> Pos -> ShowS

show :: Pos -> String

showList :: [Pos] -> ShowS

space1 :: (Space s, Traversable f) => f (Element s) -> s

the containing space of a non-empty Traversable

memberOf :: Space s => Element s -> s -> Bool

contains :: Space s => s -> s -> Bool

is a space contained within another?

disjoint :: Space s => s -> s -> Bool

are two spaces disjoint?

width :: (Space s, Num (Element s)) => s -> Element s

distance between boundaries

(+/-) :: (Space s, Num (Element s)) => Element s -> Element s -> s infixl 6

create a space centered on a plus or minus b

monotone :: (Space a, Space b) => (Element a -> Element b) -> a -> b

lift a monotone function (increasing or decreasing) over a given space

eps :: (Space s, Fractional (Element s)) => Element s -> Element s -> s

a small space

widen :: (Space s, Num (Element s)) => Element s -> s -> s

widen a space

widenEps :: (Space s, Fractional (Element s)) => Element s -> s -> s

widen by a small amount

scale :: (Num (Element s), Space s) => Element s -> s -> s

scale a Space

move :: (Num (Element s), Space s) => Element s -> s -> s

move a Space