Safe Haskell	None
Language	GHC2024

Language.Drasil.Classes

Contents

Classes
- Chunks
- Expr and expressions

Description

Defining all the classes which represent knowledge-about-knowledge.

Synopsis

class IsChunk c => NamedIdea c where
- term :: Lens' c NP
class NamedIdea c => Idea c where
- getA :: c -> Maybe String
class NamedIdea c => CommonIdea c where
- abrv :: c -> String
type Concept c = (Idea c, Definition c)
class Definition c where
- defn :: Lens' c Sentence
class ConceptDomain c where
- cdom :: c -> [UID]
type Quantity c = (Idea c, HasSpace c, HasSymbol c)
class HasUnitSymbol u where
- usymb :: u -> USymb
class HasReasVal c where
- reasVal :: Lens' c (Maybe ReasonableValue)
class Constrained c where
- constraints :: Lens' c [ConstraintE]
class HasAdditionalNotes c where
- getNotes :: Lens' c [Sentence]
class (Idea u, Definition u, HasUnitSymbol u) => IsUnit u where
- udefn :: u -> Maybe UDefn
- getUnits :: u -> [UID]
class UnitEq u where
- uniteq :: Lens' u UDefn
class Express c where
- express :: c -> ModelExpr
- mexpress :: c -> NonEmpty ModelExpr
class DefiningExpr (c :: Type -> Type) where
- defnExpr :: Lens' (c e) e

Classes

Chunks

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 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 (`NP`) 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 `DefinedQuantityDict` used to make the `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods term :: Lens' UncertQ NP Source #
NamedIdea UnitDefn Source #	Finds term (`NP`) of the `ConceptChunk` used to make the `UnitDefn`.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods term :: Lens' UnitDefn NP Source #
NamedIdea ConceptInstance Source #	Finds term (`NP`) of the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Document.ConceptInstance Methods term :: Lens' ConceptInstance 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 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 `DefinedQuantityDict` 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 ConceptInstance Source #	Finds the idea contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Document.ConceptInstance Methods getA :: ConceptInstance -> Maybe String Source #
Idea (QDefinition e) Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods getA :: QDefinition e -> Maybe String Source #

class NamedIdea c => CommonIdea c where Source #

CommonIdea is a NamedIdea with the additional constraint that it must have an abbreviation. This is the main distinction between getA and abrv, where getA may return Nothing, while abrv will always return the abbreviation.

Methods

abrv :: c -> String Source #

Introduces abrv which necessarily provides an abbreviation.

Instances

Instances details

CommonIdea CI Source #	Finds the idea of a `CI` (abbreviation).
Instance details Defined in Language.Drasil.Chunk.CommonIdea Methods abrv :: CI -> String Source #

type Concept c = (Idea c, Definition c) Source #

Concepts are Ideas with definitions and domains.

class Definition c where Source #

Defines a chunk.

Methods

defn :: Lens' c Sentence Source #

Provides (a Lens to) the definition for a chunk.

Instances

Instances details

Definition CodeChunk Source #	Finds the Definition contained in the `DefinedQuantityDict` used to make the CodeChunk
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeChunk Sentence Source #
Definition CodeFuncChunk Source #	Finds the Definition of the `CodeChunk` used to make the `CodeFuncChunk`
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeFuncChunk Sentence Source #
Definition CodeVarChunk Source #
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeVarChunk Sentence Source #
Definition ConceptChunk Source #	Finds definition of a `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods defn :: Lens' ConceptChunk Sentence Source #
Definition ConstrConcept Source #	Finds definition of the `DefinedQuantityDict` used to make the `ConstrConcept`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods defn :: Lens' ConstrConcept Sentence Source #
Definition DefinedQuantityDict Source #	Finds the definition contained in the `ConceptChunk` used to make the `DefinedQuantityDict`.
Instance details Defined in Language.Drasil.Chunk.DefinedQuantity Methods defn :: Lens' DefinedQuantityDict Sentence Source #
Definition UncertQ Source #	Finds definition of the `DefinedQuantityDict` used to make the `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods defn :: Lens' UncertQ Sentence Source #
Definition UnitDefn Source #	Finds definition of the `ConceptChunk` used to make the `UnitDefn`.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods defn :: Lens' UnitDefn Sentence Source #
Definition ConceptInstance Source #	Finds the definition contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Document.ConceptInstance Methods defn :: Lens' ConceptInstance Sentence Source #
Definition (QDefinition e) Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods defn :: Lens' (QDefinition e) Sentence Source #

class ConceptDomain c where Source #

Some concepts have a domain (related information encoded in UIDs to other chunks).

Methods

cdom :: c -> [UID] Source #

Provides Getter for the concept domain tags for a chunk

cdom should be exported for use by the Drasil framework, but should not be exported beyond that.

Instances

Instances details

ConceptDomain ConceptChunk Source #	Finds the domain of `UID`s of a `ConceptChunk`.
Instance details Defined in Language.Drasil.Chunk.Concept.Core Methods cdom :: ConceptChunk -> [UID] Source #
ConceptDomain ConceptInstance Source #	Finds the domain contained in the `ConceptChunk` used to make the `ConceptInstance`.
Instance details Defined in Language.Drasil.Document.ConceptInstance Methods cdom :: ConceptInstance -> [UID] Source #

type Quantity c = (Idea c, HasSpace c, HasSymbol c) Source #

A Quantity is an Idea with a Space and a Symbol. In theory, it should also restrict to being a part of MayHaveUnit, but that causes all sorts of import cycles (or lots of orphans).

class HasUnitSymbol u where Source #

Some chunks store a unit symbol.

Methods

usymb :: u -> USymb Source #

Provides the ability to hold a unit symbol (USymb).

Instances

Instances details

HasUnitSymbol UnitDefn Source #	Finds unit symbol of the `ConceptChunk` used to make the `UnitDefn`.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods usymb :: UnitDefn -> USymb Source #

class HasReasVal c where Source #

A Quantity that could have a reasonable value.

Methods

reasVal :: Lens' c (Maybe ReasonableValue) Source #

Provides a Lens to the possible reasonable value.

Instances

Instances details

HasReasVal ConstrConcept Source #	Finds a reasonable value for the `ConstrConcept`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods reasVal :: Lens' ConstrConcept (Maybe ReasonableValue) Source #
HasReasVal UncertQ Source #	Finds a reasonable value for the `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods reasVal :: Lens' UncertQ (Maybe ReasonableValue) Source #

class Constrained c where Source #

The Constrained class is a Quantity that has value constraints. It does not enforce Quantity at this point.

Methods

constraints :: Lens' c [ConstraintE] Source #

Provides a Lens to the Constraints.

Instances

Instances details

Constrained ConstrConcept Source #	Finds the `Constraint`s of a `ConstrConcept`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods constraints :: Lens' ConstrConcept [ConstraintE] Source #
Constrained UncertQ Source #	Finds the `Constraint`s of a `UncertQ`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods constraints :: Lens' UncertQ [ConstraintE] Source #

class HasAdditionalNotes c where Source #

Records any additional notes needed to avoid losing information

Methods

getNotes :: Lens' c [Sentence] Source #

Provides a Lens to the notes.

class (Idea u, Definition u, HasUnitSymbol u) => IsUnit u where Source #

Units are Ideas with a Definition which store a unit symbol. They must also be explicitly declared to be instances of IsUnit.

Methods

udefn :: u -> Maybe UDefn Source #

May have a unit definition.

getUnits :: u -> [UID] Source #

Holds units as a list of UID.

Instances

Instances details

IsUnit UnitDefn Source #	Gets the UnitDefn and contributing units.
Instance details Defined in Language.Drasil.Chunk.UnitDefn Methods udefn :: UnitDefn -> Maybe UDefn Source # getUnits :: UnitDefn -> [UID] Source #

class UnitEq u where Source #

Contains a UDefn

Methods

uniteq :: Lens' u UDefn Source #

Provides the Lens to a unit definition.

Expr and expressions

class Express c where Source #

Express something axiomatically.

Minimal complete definition

express | mexpress

Methods

express :: c -> ModelExpr Source #

Express something as a single fact.

mexpress :: c -> NonEmpty ModelExpr Source #

Express something as a series of facts.

Instances

Instances details

Express ConstrConcept Source #	Convert the symbol of the `ConstrConcept` to a `ModelExpr`.
Instance details Defined in Language.Drasil.Chunk.Constrained Methods express :: ConstrConcept -> ModelExpr Source # mexpress :: ConstrConcept -> NonEmpty ModelExpr Source #
Express DefinedQuantityDict Source #	Convert the symbol of the `DefinedQuantityDict` to a `ModelExpr`.
Instance details Defined in Language.Drasil.Chunk.DefinedQuantity Methods express :: DefinedQuantityDict -> ModelExpr Source # mexpress :: DefinedQuantityDict -> NonEmpty ModelExpr Source #
Express UncertQ Source #	Convert the symbol of the `UncertQ` to a `ModelExpr`.
Instance details Defined in Language.Drasil.Chunk.UncertainQuantity Methods express :: UncertQ -> ModelExpr Source # mexpress :: UncertQ -> NonEmpty ModelExpr Source #
Express Expr Source #	Rewriting `Expr`s using the `ModelExpr` language.
Instance details Defined in Language.Drasil.ExprClasses Methods express :: Expr -> ModelExpr Source # mexpress :: Expr -> NonEmpty ModelExpr Source #
Express Literal Source #
Instance details Defined in Language.Drasil.ExprClasses Methods express :: Literal -> ModelExpr Source # mexpress :: Literal -> NonEmpty ModelExpr Source #
Express ModelExpr Source #	No change, it's already a `ModelExpr`.
Instance details Defined in Language.Drasil.ExprClasses Methods express :: ModelExpr -> ModelExpr Source # mexpress :: ModelExpr -> NonEmpty ModelExpr Source #
Express e => Express (QDefinition e) Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods express :: QDefinition e -> ModelExpr Source # mexpress :: QDefinition e -> NonEmpty ModelExpr Source #
Express t => Express (NonEmpty t) Source #
Instance details Defined in Language.Drasil.ExprClasses Methods express :: NonEmpty t -> ModelExpr Source # mexpress :: NonEmpty t -> NonEmpty ModelExpr Source #
Express t => Express [t] Source #
Instance details Defined in Language.Drasil.ExprClasses Methods express :: [t] -> ModelExpr Source # mexpress :: [t] -> NonEmpty ModelExpr Source #

class DefiningExpr (c :: Type -> Type) where Source #

Methods

defnExpr :: Lens' (c e) e Source #

Provides a Lens to the expression. TODO: Well, technically, e doesn't need to be an "expression" of any sorts. It just needs to be _something_, and it would have approximately have same meaning.

Instances

Instances details

DefiningExpr QDefinition Source #
Instance details Defined in Language.Drasil.Chunk.Eq Methods defnExpr :: Lens' (QDefinition e) e Source #