Skip to main content

Documentation

Functions

add_topic(Function f,Charstring topic)->Topic

Add topic to function f


alltopics()->Bag of Topic

All topics in database


apropos(Charstring str)->Bag of Function

Functions whose names contain str


auto_complete(Charstring prefix)->Vector of Record

create_topic(Charstring tn)->Topic t

Create a new topic named tn


current_topics(Vector of Charstring tn)->Bag of Topic

Associate topics in tn with succeeding function definitions


doc(Function fn)->Bag of Charstring

Documentation of function fn


doc(Charstring fn)->Bag of Charstring

Documentation of function named fn


doc(Topic t)->Charstring

Documentation of functions in topic t


file:current_folder()->Charstring

Get the folder of the current file, or current working directory if no file is being loaded.


functions(Topic t)->Bag of Function

The functions associated with topic t


mddoc(Function fn)->Bag of Charstring

Documentation of function fn in Markdown format.


mddoc(Charstring fn)->Bag of Charstring

Documentation of function named fn in Markdown format.


mddoc(Topic t)->Charstring

Documentation of functions in topic t as Markdown


name(Topic t)->Charstring nm

The name of topic t


signature(Type t)->Charstring

The signature of type t


signature(Function f)->Bag of Charstring

The signature of resolvent f or the signatures of all resolvents of the generic function f


sourcecode(Type t)->Charstring

Source code to of user defined type t


sourcecode(Function f)->Bag of Charstring

Source code of function f


sourcecode(Charstring fn)->Bag of Charstring

Source code of resolvents of function named fn


topics(Function f)->Bag of Topic

The topics associated with function f


topic_intro(Charstring topic_name)->Charstring

topic_named(Charstring tn)->Topic

Get the topic named tn


visible(Function f)->Boolean

True if object f is not a hidden function