Private functions

DescVarArg is a Vararg of symbols. DescVarArg is a type alias for a Vararg of symbols.

julia> const DescVarArg = Vararg{Symbol}

See also: Description.

struct AmbiguousDescription <: CTBase.CTException

Exception thrown when the description is ambiguous / incorrect.

Fields

• var::Tuple{Vararg{Symbol}}

abstract type CTException <: Exception

Abstract type for exceptions.

A description is a tuple of symbols. Description is a type alias for a tuple of symbols.

julia> const Description = Tuple{DescVarArg}

See also: DescVarArg.

Example

Base.show is overloaded for descriptions, that is tuple of descriptions are printed as follows:

julia> display( ( (:a, :b), (:b, :c) ) )
(:a, :b)
(:b, :c)

struct ExtensionError <: CTBase.CTException

Exception thrown when an extension is not loaded but the user tries to call a function of it.

Fields

• weakdeps::Tuple{Vararg{Symbol}}

struct IncorrectArgument <: CTBase.CTException

Exception thrown when an argument is inconsistent.

Fields

• var::String

struct IncorrectMethod <: CTBase.CTException

Exception thrown when a method is incorrect.

Fields

• var::Symbol

struct IncorrectOutput <: CTBase.CTException

Exception thrown when the output is incorrect.

Fields

• var::String

struct NotImplemented <: CTBase.CTException

Exception thrown when a method is not implemented.

Fields

• var::String

struct ParsingError <: CTBase.CTException

Exception thrown for syntax error during abstract parsing.

Fields

• var::String

struct UnauthorizedCall <: CTBase.CTException

Exception thrown when a call to a function is not authorized.

Fields

• var::String

Type alias for a real number.

julia> const ctNumber = Real

show(
    io::IO,
    _::MIME{Symbol("text/plain")},
    descriptions::Tuple{Vararg{Tuple{Vararg{Symbol}}}}
)

Print a tuple of descriptions.

Example

julia> display( ( (:a, :b), (:b, :c) ) )
(:a, :b)
(:b, :c)

showerror(io::IO, e::CTBase.AmbiguousDescription)

Print the exception.

showerror(io::IO, e::CTBase.ExtensionError)

Print the exception.

showerror(io::IO, e::CTBase.IncorrectArgument)

Print the exception.

showerror(io::IO, e::CTBase.IncorrectMethod)

Print the exception.

showerror(io::IO, e::CTBase.IncorrectOutput)

Print the exception.

showerror(io::IO, e::CTBase.NotImplemented)

Print the exception.

showerror(io::IO, e::CTBase.ParsingError)

Print the exception.

showerror(io::IO, e::CTBase.UnauthorizedCall)

Print the exception.

__display() -> Bool

Used to set the default value of the display argument. The default value is true, which means that the output is printed during resolution.

add(
    x::Tuple{Vararg{Tuple{Vararg{Symbol}}}},
    y::Tuple{Vararg{Symbol}}
) -> Tuple{Tuple{Vararg{Symbol}}}

Concatenate the description y to the tuple of descriptions x if x does not contain y and return the new tuple of descriptions. Throw an error if the description y is already contained in x.

Example

julia> descriptions = ()
julia> descriptions = add(descriptions, (:a,))
(:a,)
julia> descriptions = add(descriptions, (:b,))
(:a,)
(:b,)
julia> descriptions = add(descriptions, (:b,))
ERROR: IncorrectArgument: the description (:b,) is already in ((:a,), (:b,))

add(
    x::Tuple{},
    y::Tuple{Vararg{Symbol}}
) -> Tuple{Tuple{Vararg{Symbol}}}

Return a tuple containing only the description y.

Example

julia> descriptions = ()
julia> descriptions = add(descriptions, (:a,))
(:a,)
julia> print(descriptions)
((:a,),)
julia> descriptions[1]
(:a,)

ctindice(i::Int64) -> Char

Return i ∈ [0, 9] as a subscript.

ctindices(i::Int64) -> String

Return i > 0 as a subscript.

ctupperscript(i::Int64) -> Char

Return i ∈ [0, 9] as an upperscript.

ctupperscripts(i::Int64) -> String

Return i > 0 as an upperscript.

getFullDescription(
    desc::Tuple{Vararg{Symbol}},
    desc_list::Tuple{Vararg{Tuple{Vararg{Symbol}}}}
) -> Tuple{Vararg{Symbol}}

Return a complete description from an incomplete description desc and a list of complete descriptions desc_list. If several complete descriptions are possible, then the first one is returned.

Example

julia> desc_list = ((:a, :b), (:b, :c), (:a, :c))
(:a, :b)
(:b, :c)
(:a, :c)
julia> getFullDescription((:a,), desc_list)
(:a, :b)

remove(
    x::Tuple{Vararg{Symbol}},
    y::Tuple{Vararg{Symbol}}
) -> Tuple{Vararg{Symbol}}

Return the difference between the description x and the description y.

Example

julia> remove((:a, :b), (:a,))
(:b,)