Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.CodeDefinition

Synopsis

data CodeDefinition
data DefinitionType
- = Definition
- | ODE
qtoc :: (Quantity (q Expr), MayHaveUnit (q Expr), DefiningExpr q, Concept (q Expr)) => q Expr -> CodeDefinition
qtov :: CanGenCode e => QDefinition e -> CodeDefinition
odeDef :: ODEInfo -> CodeDefinition
auxExprs :: Lens' CodeDefinition [CodeExpr]
defType :: Lens' CodeDefinition DefinitionType

Documentation

data CodeDefinition Source #

A chunk for pairing a mathematical definition with a CodeChunk.

Instances

Instances details

CodeIdea CodeDefinition Source #	Finds the code name of a `CodeDefinition`. `Function` `CodeDefinition`s are named with the function prefix to distinguish them from the corresponding variable version.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods codeName :: CodeDefinition -> String # codeChunk :: CodeDefinition -> CodeChunk #
DefiningCodeExpr CodeDefinition Source #	Finds the defining expression of a CodeDefinition.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods codeExpr :: Lens' CodeDefinition CodeExpr #
HasUID CodeDefinition Source #	Finds the `UID` of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods uid :: Getter CodeDefinition UID #
Idea CodeDefinition Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods getA :: CodeDefinition -> Maybe String #
NamedIdea CodeDefinition Source #	Finds the term (`Sentence`) of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods term :: Lens' CodeDefinition NP #
MayHaveUnit CodeDefinition Source #	Finds the units of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods getUnit :: CodeDefinition -> Maybe UnitDefn #
ConceptDomain CodeDefinition Source #	Finds the concept domains of the `CodeChunk` used to make the `CodeDefinition`
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods cdom :: CodeDefinition -> [UID] #
Definition CodeDefinition Source #	Finds the Definition of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods defn :: Lens' CodeDefinition Sentence #
Quantity CodeDefinition Source #	`CodeDefinition`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition
HasSpace CodeDefinition Source #	Finds the `Space` of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods typ :: Getter CodeDefinition Space #
HasSymbol CodeDefinition Source #	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `CodeDefinition`.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods symbol :: CodeDefinition -> Stage -> Symbol #
Eq CodeDefinition Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods (==) :: CodeDefinition -> CodeDefinition -> Bool # (/=) :: CodeDefinition -> CodeDefinition -> Bool #

data DefinitionType Source #

The definition may be specialized to use ODEs.

Constructors

Definition
ODE

qtoc :: (Quantity (q Expr), MayHaveUnit (q Expr), DefiningExpr q, Concept (q Expr)) => q Expr -> CodeDefinition Source #

Constructs a CodeDefinition where the underlying CodeChunk is for a function.

qtov :: CanGenCode e => QDefinition e -> CodeDefinition Source #

Constructs a CodeDefinition where the underlying CodeChunk is for a variable.

odeDef :: ODEInfo -> CodeDefinition Source #

Constructs a CodeDefinition for an ODE.

auxExprs :: Lens' CodeDefinition [CodeExpr] Source #

defType :: Lens' CodeDefinition DefinitionType Source #