Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.NamedIdea

Contents

Type
Classes
Constructors

Description

The lowest level of chunks in Drasil. It all starts with an identifier and a term.

Synopsis

data IdeaDict
class IsChunk c => NamedIdea c where
- term :: Lens' c NP
class NamedIdea c => Idea c where
- getA :: c -> Maybe String
idea :: UID -> NP -> String -> IdeaDict
idea' :: UID -> NP -> IdeaDict

Type

data IdeaDict Source #

IdeaDict is the canonical dictionary associated to an Idea. Contains a UID and a term that could have an abbreviation (Maybe String).

Ex. The project name "Double Pendulum" may have the abbreviation DblPend.

Instances

Instances details

Generic IdeaDict Source #
Instance details Defined in Language.Drasil.Chunk.NamedIdea Associated Types type Rep IdeaDict :: Type -> Type # Methods from :: IdeaDict -> Rep IdeaDict x # to :: Rep IdeaDict x -> IdeaDict #
HasChunkRefs IdeaDict Source #
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods chunkRefs :: IdeaDict -> Set UID #
HasUID IdeaDict Source #	Finds the `UID` of the `IdeaDict` used to make the `IdeaDict`.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods uid :: Getter IdeaDict UID #
Idea IdeaDict Source #	Finds the abbreviation of the `IdeaDict`.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods getA :: IdeaDict -> Maybe String Source #
NamedIdea IdeaDict Source #	Finds the term (`NP`) of the `IdeaDict` used to make the `IdeaDict`.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods term :: Lens' IdeaDict NP Source #
Eq IdeaDict Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods (==) :: IdeaDict -> IdeaDict -> Bool # (/=) :: IdeaDict -> IdeaDict -> Bool #
type Rep IdeaDict Source #
Instance details Defined in Language.Drasil.Chunk.NamedIdea type Rep IdeaDict = D1 ('MetaData "IdeaDict" "Language.Drasil.Chunk.NamedIdea" "drasil-lang-0.1.60.0-GSVjWL6zqIJGx21JJ17VJN" 'False) (C1 ('MetaCons "IdeaDict" 'PrefixI 'True) (S1 ('MetaSel ('Just "_uu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UID) :: (S1 ('MetaSel ('Just "_np") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NP) :: S1 ('MetaSel ('Just "mabbr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe String)))))

Classes

class IsChunk c => NamedIdea c where Source #

A NamedIdea is a term that we've identified (has a UID) as being worthy of naming.

Methods

term :: Lens' c NP Source #

Lens to the term (an NP).

Instances

Instances details

NamedIdea CodeChunk Source #	Finds the term (`NP`) of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeChunk NP Source #
NamedIdea CodeFuncChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeFuncChunk NP Source #
NamedIdea CodeVarChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeVarChunk NP Source #
NamedIdea CI Source #	Finds term (`NP`) of the `IdeaDict` used to make the `CI`.
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods term :: Lens' CI NP Source #
NamedIdea ConceptChunk Source #	Finds term (`NP`) of the `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods term :: Lens' ConceptChunk NP Source #
NamedIdea ConceptInstance Source #	Finds term (`NP`) of the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods term :: Lens' ConceptInstance NP Source #
NamedIdea ConstrConcept Source #	Finds term (`NP`) of the `DefinedQuantityDict` used to make the `ConstrConcept`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods term :: Lens' ConstrConcept NP Source #
NamedIdea DefinedQuantityDict Source #	Finds the term (`Sentence`) of the `ConceptChunk` used to make the `DefinedQuantityDict`.
Instance details Defined in Language.Drasil.Chunk.DefinedQuantity Methods term :: Lens' DefinedQuantityDict NP Source #
NamedIdea IdeaDict Source #	Finds the term (`NP`) of the `IdeaDict` used to make the `IdeaDict`.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods term :: Lens' IdeaDict NP Source #
NamedIdea UncertQ Source #	Finds term (`NP`) of the `ConstrConcept` used to make the `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods term :: Lens' UncertQ NP Source #
NamedIdea UnitDefn Source #	Finds term (`Sentence`) of the `ConceptChunk` used to make the `UnitDefn`.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods term :: Lens' UnitDefn NP Source #
NamedIdea (QDefinition e) Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods term :: Lens' (QDefinition e) NP Source #

class NamedIdea c => Idea c where Source #

An Idea is the combination of a NamedIdea and a CommonIdea. In other words, it may have an acronym/abbreviation.

Methods

getA :: c -> Maybe String Source #

Get the acronym/abbreviation.

Instances

Instances details

Idea CodeChunk Source #	Finds the idea contained in the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeChunk -> Maybe String Source #
Idea CodeFuncChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeFuncChunk -> Maybe String Source #
Idea CodeVarChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeVarChunk -> Maybe String Source #
Idea CI Source #	Finds the idea of a `CI` (abbreviation).
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods getA :: CI -> Maybe String Source #
Idea ConceptChunk Source #	Finds the abbreviation of the `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getA :: ConceptChunk -> Maybe String Source #
Idea ConceptInstance Source #	Finds the idea contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods getA :: ConceptInstance -> Maybe String Source #
Idea ConstrConcept Source #	Finds the idea contained in the `DefinedQuantityDict` used to make the `ConstrConcept`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods getA :: ConstrConcept -> Maybe String Source #
Idea DefinedQuantityDict Source #	Finds the idea contained in the `ConceptChunk` used to make the `DefinedQuantityDict`.
Instance details Defined in Language.Drasil.Chunk.DefinedQuantity Methods getA :: DefinedQuantityDict -> Maybe String Source #
Idea IdeaDict Source #	Finds the abbreviation of the `IdeaDict`.
Instance details Defined in Language.Drasil.Chunk.NamedIdea Methods getA :: IdeaDict -> Maybe String Source #
Idea UncertQ Source #	Finds the idea contained in the `ConstrConcept` used to make the `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods getA :: UncertQ -> Maybe String Source #
Idea UnitDefn Source #	Finds the idea contained in the `ConceptChunk` used to make the `UnitDefn`.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods getA :: UnitDefn -> Maybe String Source #
Idea (QDefinition e) Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods getA :: QDefinition e -> Maybe String Source #

Constructors

idea Source #

Arguments

:: UID	The `UID`.
-> NP	The `term` being declared.
-> String	The `term`s acronym/abbreviation.
-> IdeaDict

Construct an IdeaDict (with an acronym/abbreviation).

idea' Source #

Arguments

:: UID	The `UID`.
-> NP	The `term` being declared.
-> IdeaDict

Construct an IdeaDict (without an acronym/abbreviation).