Diagrams.Core.Names

This module defines a type of names which can be used for referring to subdiagrams, and related types.

Names

Atomic names

data AName where

Atomic names. AName is just an existential wrapper around things which are Typeable, Ord and Show.

Constructors

AName :: (Typeable a, Ord a, Show a) => a -> AName

Instances

Show AName

Defined in Diagrams.Core.Names

Methods

showsPrec :: Int -> AName -> ShowS

show :: AName -> String

showList :: [AName] -> ShowS

IsName AName

Defined in Diagrams.Core.Names

Methods

toName :: AName -> Name

Eq AName

Defined in Diagrams.Core.Names

Methods

(==) :: AName -> AName -> Bool

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

Ord AName

Defined in Diagrams.Core.Names

Methods

compare :: AName -> AName -> Ordering

(<) :: AName -> AName -> Bool

(<=) :: AName -> AName -> Bool

(>) :: AName -> AName -> Bool

(>=) :: AName -> AName -> Bool

max :: AName -> AName -> AName

min :: AName -> AName -> AName

Each Name Name AName AName

Defined in Diagrams.Core.Names

Methods

each :: Traversal Name Name AName AName

_AName :: (Typeable a, Ord a, Show a) => Prism' AName a

Prism onto AName.

Names

newtype Name

A (qualified) name is a (possibly empty) sequence of atomic names.

Constructors

Name [AName]

Instances

Monoid Name

Defined in Diagrams.Core.Names

Methods

mempty :: Name

mappend :: Name -> Name -> Name

mconcat :: [Name] -> Name

Semigroup Name

Defined in Diagrams.Core.Names

Methods

(<>) :: Name -> Name -> Name

sconcat :: NonEmpty Name -> Name

stimes :: Integral b => b -> Name -> Name

Show Name

Defined in Diagrams.Core.Names

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

IsName Name

Defined in Diagrams.Core.Names

Methods

toName :: Name -> Name

Qualifiable Name

Of course, names can be qualified using (.>).

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a => a -> Name -> Name

Eq Name

Defined in Diagrams.Core.Names

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Diagrams.Core.Names

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Wrapped Name

Defined in Diagrams.Core.Names

Associated Types

type Unwrapped Name

Methods

_Wrapped' :: Iso' Name (Unwrapped Name)

Rewrapped Name Name

Defined in Diagrams.Core.Names

Each Name Name AName AName

Defined in Diagrams.Core.Names

Methods

each :: Traversal Name Name AName AName

Action Name a => Action Name (Deletable a)

Defined in Diagrams.Core.Types

Methods

act :: Name -> Deletable a -> Deletable a

Action Name (Envelope v n)

Defined in Diagrams.Core.Types

Methods

act :: Name -> Envelope v n -> Envelope v n

Action Name (Trace v n)

Defined in Diagrams.Core.Types

Methods

act :: Name -> Trace v n -> Trace v n

Action Name (Query v n m)

Defined in Diagrams.Core.Types

Methods

act :: Name -> Query v n m -> Query v n m

Action Name (SubMap b v n m)

A name acts on a name map by qualifying every name in it.

Defined in Diagrams.Core.Types

Methods

act :: Name -> SubMap b v n m -> SubMap b v n m

type Unwrapped Name

Defined in Diagrams.Core.Names

type Unwrapped Name = [AName]

class (Typeable a, Ord a, Show a) => IsName a where

Class for those types which can be used as names. They must support Typeable (to facilitate extracting them from existential wrappers), Ord (for comparison and efficient storage) and Show.

To make an instance of IsName, you need not define any methods, just declare it.

WARNING: it is not recommended to use GeneralizedNewtypeDeriving in conjunction with IsName, since in that case the underlying type and the newtype will be considered equivalent when comparing names. For example:

    newtype WordN = WordN Int deriving (Show, Ord, Eq, Typeable, IsName)
  

is unlikely to work as intended, since (1 :: Int) and (WordN 1) will be considered equal as names. Instead, use

    newtype WordN = WordN Int deriving (Show, Ord, Eq, Typeable, IsName)
    instance IsName WordN
  

Minimal complete definition

Nothing

Methods

toName :: a -> Name

Instances

IsName AName

Defined in Diagrams.Core.Names

Methods

toName :: AName -> Name

IsName Name

Defined in Diagrams.Core.Names

Methods

toName :: Name -> Name

IsName Integer

Defined in Diagrams.Core.Names

Methods

toName :: Integer -> Name

IsName ()

Defined in Diagrams.Core.Names

Methods

toName :: () -> Name

IsName Bool

Defined in Diagrams.Core.Names

Methods

toName :: Bool -> Name

IsName Char

Defined in Diagrams.Core.Names

Methods

toName :: Char -> Name

IsName Double

Defined in Diagrams.Core.Names

Methods

toName :: Double -> Name

IsName Float

Defined in Diagrams.Core.Names

Methods

toName :: Float -> Name

IsName Int

Defined in Diagrams.Core.Names

Methods

toName :: Int -> Name

IsName a => IsName (Maybe a)

Defined in Diagrams.Core.Names

Methods

toName :: Maybe a -> Name

IsName a => IsName [a]

Defined in Diagrams.Core.Names

Methods

toName :: [a] -> Name

(IsName a, IsName b) => IsName (a, b)

Defined in Diagrams.Core.Names

Methods

toName :: (a, b) -> Name

(IsName a, IsName b, IsName c) => IsName (a, b, c)

Defined in Diagrams.Core.Names

Methods

toName :: (a, b, c) -> Name

(.>) :: (IsName a1, IsName a2) => a1 -> a2 -> Name infixr 5

Convenient operator for writing qualified names with atomic components of different types. Instead of writing toName a1 <> toName a2 <> toName a3 you can just write a1 .> a2 .> a3.

eachName :: (Typeable a, Ord a, Show a) => Traversal' Name a

Traversal over each name in a Name that matches the target type.

>>> toListOf eachName (a .> False .> b) :: String
"ab"
>>> a .> True .> b & eachName %~ not
a .> False .> b

Note that the type of the name is very important.

>>> sumOf eachName ((1::Int) .> (2 :: Integer) .> (3 :: Int)) :: Int
4
>>> sumOf eachName ((1::Int) .> (2 :: Integer) .> (3 :: Int)) :: Integer
2

Qualifiable

class Qualifiable q where

Instances of Qualifiable are things which can be qualified by prefixing them with a name.

Methods

(.>>) :: IsName a => a -> q -> q infixr 5

Qualify with the given name.

Instances

Qualifiable Name

Of course, names can be qualified using (.>).

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a => a -> Name -> Name

(Ord a, Qualifiable a) => Qualifiable (Set a)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> Set a -> Set a

Qualifiable a => Qualifiable (TransInv a)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> TransInv a -> TransInv a

Qualifiable a => Qualifiable [a]

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> [a] -> [a]

Qualifiable a => Qualifiable (Map k a)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> Map k a -> Map k a

Qualifiable a => Qualifiable (Measured n a)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> Measured n a -> Measured n a

Qualifiable a => Qualifiable (b -> a)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> (b -> a) -> b -> a

(Qualifiable a, Qualifiable b) => Qualifiable (a, b)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> (a, b) -> (a, b)

(Qualifiable a, Qualifiable b, Qualifiable c) => Qualifiable (a, b, c)

Defined in Diagrams.Core.Names

Methods

(.>>) :: IsName a0 => a0 -> (a, b, c) -> (a, b, c)

(Metric v, OrderedField n, Semigroup m) => Qualifiable (QDiagram b v n m)

Diagrams can be qualified so that all their named points can now be referred to using the qualification prefix.

Defined in Diagrams.Core.Types

Methods

(.>>) :: IsName a => a -> QDiagram b v n m -> QDiagram b v n m

Qualifiable (SubMap b v n m)

SubMaps are qualifiable: if ns is a SubMap, then a |> ns is the same SubMap except with every name qualified by a.

Defined in Diagrams.Core.Types

Methods

(.>>) :: IsName a => a -> SubMap b v n m -> SubMap b v n m