drasil-theory-0.1.0.0: A framework for code and document generation for scientific software - Theory SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Theory.Drasil.Theory

Description

Defines types and functions for Theoretical Models.

Synopsis

Types

data TheoryModel Source #

A TheoryModel is a collection of:

Right now, neither the definition context (vctx) nor the spaces (spc) are ever defined.

Instances

Instances details
HasChunkRefs TheoryModel Source # 
Instance details

Defined in Theory.Drasil.Theory

HasUID TheoryModel Source #

Finds the UID of a TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

uid :: Getter TheoryModel UID #

Idea TheoryModel Source #

Finds the idea of the ConceptChunk contained in the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

NamedIdea TheoryModel Source #

Finds the term (Sentence) of the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

term :: Lens' TheoryModel NP #

CommonIdea TheoryModel Source #

Finds the idea of a TheoryModel (abbreviation).

Instance details

Defined in Theory.Drasil.Theory

Methods

abrv :: TheoryModel -> String #

ConceptDomain TheoryModel Source #

Finds the domain of the ConceptChunk contained in a TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

cdom :: TheoryModel -> [UID] #

Definition TheoryModel Source #

Finds the definition of the ConceptChunk contained in a TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

defn :: Lens' TheoryModel Sentence #

HasAdditionalNotes TheoryModel Source #

Finds any additional notes for the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

getNotes :: Lens' TheoryModel [Sentence] #

HasDecRef TheoryModel Source #

Finds DecRefs contained in the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Methods

getDecRefs :: Lens' TheoryModel [DecRef] #

Express TheoryModel Source # 
Instance details

Defined in Theory.Drasil.Theory

HasRefAddress TheoryModel Source #

Finds the reference address of the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Referable TheoryModel Source #

Finds the reference address of a TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

HasShortName TheoryModel Source #

Finds the ShortName of the TheoryModel.

Instance details

Defined in Theory.Drasil.Theory

Constructors

tm :: ModelKind ModelExpr -> [DecRef] -> String -> [Sentence] -> TheoryModel Source #

Constructor for theory models. Must have a source. Uses the shortname of the reference address.

tmNoRefs :: ModelKind ModelExpr -> String -> [Sentence] -> TheoryModel Source #

Constructor for theory models. Uses the shortname of the reference address.