Copyright	(c) 2019-2024 Rudy Matela
License	3-Clause BSD (see the file LICENSE)
Maintainer	Rudy Matela <rudy@matela.com.br>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Express.Name

Description

Defines the Name type class.

Synopsis

class Name a where
- name :: a -> String
names :: Name a => a -> [String]
variableNamesFromTemplate :: String -> [String]

Documentation

class Name a where Source #

If we were to come up with a variable name for the given type what name would it be?

An instance for a given type Ty is simply given by:

instance Name Ty where name _ = "x"

Examples:

> name (undefined :: Int)
"x"

> name (undefined :: Bool)
"p"

> name (undefined :: [Int])
"xs"

This is then used to generate an infinite list of variable names:

> names (undefined :: Int)
["x", "y", "z", "x'", "y'", "z'", "x''", "y''", "z''", ...]

> names (undefined :: Bool)
["p", "q", "r", "p'", "q'", "r'", "p''", "q''", "r''", ...]

> names (undefined :: [Int])
["xs", "ys", "zs", "xs'", "ys'", "zs'", "xs''", "ys''", ...]

Minimal complete definition

Nothing

Methods

name :: a -> String Source #

O(1).

Returns a name for a variable of the given argument's type.

> name (undefined :: Int)
"x"

> name (undefined :: [Bool])
"ps"

> name (undefined :: [Maybe Integer])
"mxs"

The default definition is:

name _ = "x"

Instances

Instances details

Name Int16 Source #
Instance details Defined in Data.Express.Name Methods name :: Int16 -> String Source #
Name Int32 Source #
Instance details Defined in Data.Express.Name Methods name :: Int32 -> String Source #
Name Int64 Source #
Instance details Defined in Data.Express.Name Methods name :: Int64 -> String Source #
Name Int8 Source #
Instance details Defined in Data.Express.Name Methods name :: Int8 -> String Source #
Name GeneralCategory Source #
Instance details Defined in Data.Express.Name Methods name :: GeneralCategory -> String Source #
Name Word16 Source #
Instance details Defined in Data.Express.Name Methods name :: Word16 -> String Source #
Name Word32 Source #
Instance details Defined in Data.Express.Name Methods name :: Word32 -> String Source #
Name Word64 Source #
Instance details Defined in Data.Express.Name Methods name :: Word64 -> String Source #
Name Word8 Source #
Instance details Defined in Data.Express.Name Methods name :: Word8 -> String Source #
Name Ordering Source #	name (undefined :: Ordering) = "o" names (undefined :: Ordering) = ["o", "p", "q", "o'", ...]
Instance details Defined in Data.Express.Name Methods name :: Ordering -> String Source #
Name Integer Source #	name (undefined :: Integer) = "x" names (undefined :: Integer) = ["x", "y", "z", "x'", ...]
Instance details Defined in Data.Express.Name Methods name :: Integer -> String Source #
Name () Source #	name (undefined :: ()) = "u" names (undefined :: ()) = ["u", "v", "w", "u'", "v'", ...]
Instance details Defined in Data.Express.Name Methods name :: () -> String Source #
Name Bool Source #	name (undefined :: Bool) = "p" names (undefined :: Bool) = ["p", "q", "r", "p'", "q'", ...]
Instance details Defined in Data.Express.Name Methods name :: Bool -> String Source #
Name Char Source #	name (undefined :: Char) = "c" names (undefined :: Char) = ["c", "d", "e", "c'", "d'", ...]
Instance details Defined in Data.Express.Name Methods name :: Char -> String Source #
Name Double Source #	name (undefined :: Double) = "x" names (undefined :: Double) = ["x", "y", "z", "x'", ...]
Instance details Defined in Data.Express.Name Methods name :: Double -> String Source #
Name Float Source #	name (undefined :: Float) = "x" names (undefined :: Float) = ["x", "y", "z", "x'", ...]
Instance details Defined in Data.Express.Name Methods name :: Float -> String Source #
Name Int Source #	name (undefined :: Int) = "x" names (undefined :: Int) = ["x", "y", "z", "x'", "y'", ...]
Instance details Defined in Data.Express.Name Methods name :: Int -> String Source #
Name Word Source #
Instance details Defined in Data.Express.Name Methods name :: Word -> String Source #
Name (Complex a) Source #	name (undefined :: Complex) = "x" names (undefined :: Complex) = ["x", "y", "z", "x'", ...]
Instance details Defined in Data.Express.Name Methods name :: Complex a -> String Source #
Name (Ratio a) Source #	name (undefined :: Rational) = "q" names (undefined :: Rational) = ["q", "r", "s", "q'", ...]
Instance details Defined in Data.Express.Name Methods name :: Ratio a -> String Source #
Name a => Name (Maybe a) Source #	names (undefined :: Maybe Int) = ["mx", "mx1", "mx2", ...] nemes (undefined :: Maybe Bool) = ["mp", "mp1", "mp2", ...]
Instance details Defined in Data.Express.Name Methods name :: Maybe a -> String Source #
Name a => Name [a] Source #	names (undefined :: [Int]) = ["xs", "ys", "zs", "xs'", ...] names (undefined :: [Bool]) = ["ps", "qs", "rs", "ps'", ...]
Instance details Defined in Data.Express.Name Methods name :: [a] -> String Source #
(Name a, Name b) => Name (Either a b) Source #	names (undefined :: Either Int Int) = ["exy", "exy1", ...] names (undefined :: Either Int Bool) = ["exp", "exp1", ...]
Instance details Defined in Data.Express.Name Methods name :: Either a b -> String Source #
(Name a, Name b) => Name (a, b) Source #	names (undefined :: (Int,Int)) = ["xy", "zw", "xy'", ...] names (undefined :: (Bool,Bool)) = ["pq", "rs", "pq'", ...]
Instance details Defined in Data.Express.Name Methods name :: (a, b) -> String Source #
Name (a -> b) Source #	names (undefined :: ()->()) = ["f", "g", "h", "f'", ...] names (undefined :: Int->Int) = ["f", "g", "h", ...]
Instance details Defined in Data.Express.Name Methods name :: (a -> b) -> String Source #
(Name a, Name b, Name c) => Name (a, b, c) Source #	names (undefined :: (Int,Int,Int)) = ["xyz","uvw", ...] names (undefined :: (Int,Bool,Char)) = ["xpc", "xpc1", ...]
Instance details Defined in Data.Express.Name Methods name :: (a, b, c) -> String Source #
(Name a, Name b, Name c, Name d) => Name (a, b, c, d) Source #	names (undefined :: ((),(),(),())) = ["uuuu", "uuuu1", ...] names (undefined :: (Int,Int,Int,Int)) = ["xxxx", ...]
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d) -> String Source #
(Name a, Name b, Name c, Name d, Name e) => Name (a, b, c, d, e) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f) => Name (a, b, c, d, e, f) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g) => Name (a, b, c, d, e, f, g) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g, Name h) => Name (a, b, c, d, e, f, g, h) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g, h) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g, Name h, Name i) => Name (a, b, c, d, e, f, g, h, i) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g, h, i) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g, Name h, Name i, Name j) => Name (a, b, c, d, e, f, g, h, i, j) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g, h, i, j) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g, Name h, Name i, Name j, Name k) => Name (a, b, c, d, e, f, g, h, i, j, k) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g, h, i, j, k) -> String Source #
(Name a, Name b, Name c, Name d, Name e, Name f, Name g, Name h, Name i, Name j, Name k, Name l) => Name (a, b, c, d, e, f, g, h, i, j, k, l) Source #
Instance details Defined in Data.Express.Name Methods name :: (a, b, c, d, e, f, g, h, i, j, k, l) -> String Source #

names :: Name a => a -> [String] Source #

Returns na infinite list of variable names from the given type: the result of variableNamesFromTemplate after name.

> names (undefined :: Int)
["x", "y", "z", "x'", "y'", "z'", "x''", "y''", "z''", ...]

> names (undefined :: Bool)
["p", "q", "r", "p'", "q'", "r'", "p''", "q''", "r''", ...]

> names (undefined :: [Int])
["xs", "ys", "zs", "xs'", "ys'", "zs'", "xs''", "ys''", ...]

variableNamesFromTemplate :: String -> [String] Source #

Returns an infinite list of variable names based on the given template.

> variableNamesFromTemplate "x"
["x", "y", "z", "x'", "y'", ...]

> variableNamesFromTemplate "p"
["p", "q", "r", "p'", "q'", ...]

> variableNamesFromTemplate "xy"
["xy", "zw", "xy'", "zw'", "xy''", ...]