Navigation
|
Synopsis Table of Contents.
Description A top-level table of contents:
- Contents: Table of Contents.
- Motivation: Rascal is a new language for meta-programming, this is the activity of writing meta-programs. Using Rascal you create programs that read, analyse, transform, generate and/or visualize other programs.
- InstallingAndRunning: Instructions to install and run Rascal.
- Concepts: Introduction to the main concepts of the Rascal language.
- Declarations: The entities that can be declared in Rascal programs.
- Patterns: The various patterns that can be used for pattern matching.
- Expressions: The expressions available in Rascal.
- Statements: All Rascal statements.
- Libraries: The available Rascal libraries.
A full table of contents:
- Contents: Table of Contents.
- Motivation: Rascal is a new language for meta-programming, this is the activity of writing meta-programs. Using Rascal you create programs that read, analyse, transform, generate and/or visualize other programs.
- InstallingAndRunning: Instructions to install and run Rascal.
- Concepts: Introduction to the main concepts of the Rascal language.
- Declarations: The entities that can be declared in Rascal programs.
- Module: Declare a module.
- Import: Declare the import a module.
- Program: A Rascal program consists of a number of Modules.
- StaticTyping: The static type system of Rascal.
- AlgebraicDataType: Define a user-defined type (Algebraic Data Type).
- Variable: Declare a variable.
- Function: Declare a function.
- SyntaxDefinition: Syntax Definitions allow the definition of parsers for programming languages, domain-specific languages and data formats.
- Action: Actions are functions that are called when parse trees are constructed (right after parsing).
- AmbiguityDetection: Ambiguity detection helps to find ambiguities in syntax definitions.
- AmbiguityDiagnosis: Ambiguity diagnosis suggests changes to syntax definitions to make them non-ambiguous.
- Disambiguation: Disambiguation is the definition of filters on the parse trees that SyntaxDefinitions define. There are several ways of defining Disambiguation in Rascal.
- Associativity:
- Follow: a follow requirement is a conditional Symbol, constraining the characters that can immediately follow a symbol in the input source text.
- Precede:
- Priority:
- Reserve: Reserve is a conditional Symbol, constraining the set of strings that a symbol may produce.
- ParseTrees: The ParseTrees module defines an algebraic data-type for parse trees, which all parsers generated from SyntaxDefinitions produce.
- Symbol: The symbols that can occur in a syntax definition.
- Alias: Declare an alias for a type.
- Annotation: Declare an annotation type for nodes.
- Tag: b Tag declarations are not implemented (yet).
- Patterns: The various patterns that can be used for pattern matching.
- Expressions: The expressions available in Rascal.
- Values: The different types of values.
- Boolean: Boolean values.
- All: All argument expressions are true.
- And: Boolean and operator.
- Any: Any combination of argument values is true.
- Equivalence: The equivalence operator on Boolean values.
- IfDefinedElse: Test whether expression has a defined value, otherwise provide alternative.
- Implication: The implication operator on Boolean values.
- IsDefined: Test whether the value of an expression is defined.
- Match: Match a pattern against an expression.
- Negation: The not operator on Boolean values.
- NoMatch: Negated Match operator.
- Or: The or operator on Boolean values.
- Constructor: Constructors create values for user-defined datatypes (Algebraic Datatypes).
- DateTime: Date and time values.
- Integer: Integer values.
- List: List values.
- Append: Append an element at the end of a list
- Comprehension: A list comprehension generates a list value.
- Concatenation: Concatenate two lists.
- Difference: The difference between two lists.
- Equal: Equality on lists.
- in: Membership test on list elements.
- Insert: add an element in front of a list
- Intersection: Intersection of two lists.
- NotEqual: Not equal operator on lists.
- notin: Negated membership test on lists.
- Product: Compute the product of two lists.
- Slice: Retrieve a slice of a list.
- Splice: Splice the elements of a list in an enclosing list.
- StrictSubList: The strict sublist operator on lists.
- StrictSuperList: The strict super list operator on lists.
- SubList: The sublist operator on lists.
- Subscription: Retrieve a list element via its index.
- SuperList: The super list operator on lists.
- ListRelation: ListRelation values.
- Location: (Source code) location values.
- AddSegment: Locations can be concatenated with strings to add segments to the path component
- Equal: Equality operator on locations.
- FieldSelection: Field selection on locations.
- GreaterThan: The greater than operator on location values.
- GreaterThanOrEqual: The greater than or equal operator on location values.
- LessThan: The less than operator on location values.
- LessThanOrEqual: The less than or equal operator on location values.
- NotEqual: The not equal operator on location values.
- Map: Map values.
- Composition: Composition of two map values.
- Comprehension: A map comprehension generates a map value.
- Difference: The difference between two maps.
- Equal: Equality operator on maps.
- in: Membership test on the keys of a map.
- Intersection: Intersection of two maps.
- NotEqual: Not equal operator on map values.
- notin: Negated membership test on the keys of a map.
- StrictSubMap: Strict submap operator on map values.
- StrictSuperMap: Strict supermap operator on map values.
- SubMap: Submap operator on map values.
- Subscription: Retrieve a value by its key in map.
- SuperMap: Supermap operator on map values.
- Union: Union of two maps.
- Node: Node values.
- Equal: Equal operator on node values.
- GreaterThan: Greater than operator on node values.
- GreaterThanOrEqual: Greater than or equal operator on node values.
- LessThan: Less than operator on node values.
- LessThanOrEqual: Less than or equal operator on node values.
- NotEqual: Not equal operator on node values.
- Slice: Retrieve a slice of a node's argument list.
- Subscription: Retrieve an argument of a node via its index.
- Number: Numeric values.
- Range: Numeric range of values.
- Real: Real values.
- Relation: Relation values.
- Set: Set values.
- Comprehension: A set comprehension generates a set value.
- Difference: The difference between two sets.
- Equal: Equal operator on set values.
- in: Membership test on set values.
- Insert: Add an element to a set.
- Intersection: Intersection of two sets.
- NotEqual: Not equal operator on set values.
- notin: Negated membership test on set values.
- Product: The product of two set values.
- Splice: Splice the elements of a set in an enclosing set.
- StrictSubSet: Strict subset operator on set values.
- StrictSuperSet: Strict superset operator on set values.
- SubSet: Subset operator on set values.
- SuperSet: Superset operator on set values.
- Union: Union of two set values.
- String: String values.
- Tuple: Tuple values.
- Value: Values of type
value .
- Void: Values of type
void .
- Operators: The Rascal operators.
- Call: Function call.
- Comprehensions: Comprehensions provide a concise notation to conditionally generate new values.
- ConcreteSyntax: Concrete syntax is a notation for patterns that match parse trees and expressions that generate them.
- Reducer: Reduce generated values to a single value.
- Replacement: Set the value of an Annotation.
- Selection: Retrieve the value of an Annotation.
- StatementAsExpression: Statements that have a value and can be used as expressions.
- Visit: Visit the elements in a tree or value.
- Statements: All Rascal statements.
- Append: Append an element to the list value produced by various loop statements.
- Assert: An executable assertion.
- Assignment: Assign a value to a variable or more complex data structure.
- Variable: Assign to a variable.
- Subscription: Assign a single element of a structured value.
- Slice: Assign to a slice of a list or string.
- Field: Assign to a field of a tuple, relation or datatype.
- Multiple: Assign to multiple assignables.
- IsDefined: Assign but replace if value is not defined.
- Annotation: Assign to annotation.
- Constructor: Assign to constructor.
- Block: Group statements into a block.
- Break: End the execution of a while, do or for loop.
- Continue: Continue with the next iteration of while, do or for loop.
- Do: Repeat statements while condition holds.
- Fail: Let the current alternative of a pattern match fail.
- For: For loop.
- If: Conditional statement.
- Insert: Insert a value in a tree during a Visit.
- Return: Return a value as result of a Function.
- Solve: Solve a set of equalities by fixed-point iteration.
- Switch: Switch statement.
- Test: Test statement (deprecated).
- Throw: Throw an exception.
- TryCatch: Try to execute a statement and catch resulting exceptions.
- While: While loop.
- Libraries: The available Rascal libraries.
- Prelude: The Rascal standard prelude.
- Boolean:
- arbBool: Return an arbitrary Boolean value.
- fromString: Convert the strings "true" or "false" to a bool.
- toInt: Convert a Boolean value to integer.
- toReal: Convert Boolean value to real.
- toString: Convert Boolean value to string.
- DateTime:
- createDate: Create a new date.
- createDateTime: Create a new datetime (with optional timezone offset).
- createDuration: Create a new duration representing the duration between the begin and end dates.
- createInterval: Given two datetime values, create an interval.
- createTime: Create a new time (with optional timezone offset).
- dateRangeByDay: Given an interval, return a list of days.
- daysDiff: Return the difference between two dates and/or datetimes in days.
- daysInInterval: Return the number of days in an interval, including the begin and end days.
- decrementDays: Decrement the days by a given amount or by 1.
- decrementHours: Decrement the hours by a given amount or by 1.
- decrementMilliseconds: Decrement the milliseconds by a given amount or by 1.
- decrementMinutes: Decrement the minutes by a given amount or by 1.
- decrementMonths: Decrement the months by a given amount or by 1.
- decrementSeconds: Decrement the seconds by a given amount or by 1.
- decrementYears: Decrement the years by a given amount or by 1.
- Duration: A duration of time, measured in individual years, months, etc.
- incrementDays: Increment the days by given amount or by 1.
- incrementHours: Increment the hours by a given amount or by 1.`
- incrementMilliseconds: Increment the milliseconds by a given amount or by 1.
- incrementMinutes: Increment the minutes by a given amount or by 1.
- incrementMonths: Increment the months by a given amount or by 1.
- incrementSeconds: Increment the seconds by a given amount or by 1.
- incrementYears: Increment the years by given amount or by 1.
- interval: A closed interval on the time axis.
- joinDateAndTime: Create a new datetime by combining a date and a time.
- now: Get the current datetime.
- parseDate: Parse an input date given as a string using the given format string.
- parseDateInLocale: Parse an input date given as a string using a specific locale and format string.
- parseDateTime: Parse an input datetime given as a string using the given format string.
- parseDateTimeInLocale: Parse an input datetime given as a string using a specific locale and format string.
- parseTime: Parse an input time given as a string using the given format string.
- parseTimeInLocale: Parse an input time given as a string using a specific locale and format string.
- printDate: Print an input date using the given format string.
- printDateInLocale: Print an input date using a specific locale and format string.
- printDateTime: Print an input datetime using the given format string.
- printDateTimeInLocale: Print an input datetime using a specific locale and format string.
- printTime: Print an input time using the given format string.
- printTimeInLocale: Print an input time using a specific locale and format string.
- splitDateTime: Split an existing datetime into a tuple with the date and the time.
- Exception:
- IO:
- appendToFile: Append a value to a file.
- appendToFileEnc: Append a value to a file.
- bprintln: Print a value and return true.
- canEncode: Returns whether this charset can be used for encoding (use with writeFile)
- charsets: Returns all available character sets
- exists: Check whether a given location exists.
- find: Find a named file in a list of locations.
- iprint: Print an indented representation of a value.
- iprintExp: Print an indented representation of a value and returns the value as result.
- iprintln: Print a indented representation of a value and add a newline at the end.
- iprintlnExp: Print an indented representation of a value followed by a newline and returns the value as result.
- iprintToFile: Print an indented representation of a value to the specified location.
- isDirectory: Check whether a given location is a directory.
- isFile: Check whether a given location is actually a file (and not a directory).
- lastModified: Last modification date of a location.
- listEntries: List the entries in a directory.
- md5HashFile: Read the contents of a location and return its MD5 hash.
- mkDirectory: Create a new directory.
- print: Print a value without subsequent newline.
- printExp: Print a value and return it as result.
- println: Print a value to the output stream and add a newline.
- printlnExp: Print a value followed by a newline and return it as result.
- readFile: Read the contents of a location and return it as string value.
- readFileBytes: Read the contents of a file and return it as a list of bytes.
- readFileEnc: Read the contents of a location and return it as string value.
- readFileLines: Read the contents of a file location and return it as a list of strings.
- readFileLinesEnc: Read the contents of a file location and return it as a list of strings.
- rprint: Raw print of a value.
- rprintln: Raw print of a value followed by newline.
- touch: Changes the last modification date of a file.
- writeFile: Write values to a file.
- writeFileBytes: Write a list of bytes to a file.
- writeFileEnc: Write values to a file.
- List: Library functions for lists.
- delete: Delete an element from a list.
- distribution: Get the distribution of the elements of the list. That is how often does each element occur in the list?
- drop: Drop elements from the head of a list.
- dup: Remove multiple occurrences of elements in a list. The first occurrence remains.
- getOneFrom: Pick a random element from a list.
- head: Get the first element(s) from a list.
- headTail: Split a list in a head and a tail.
- index: A list of legal index values of a list.
- indexOf: Index of first occurrence of an element in a list.
- insertAt: Insert an element at a specific position in a list.
- intercalate: Join a list of values into a string separated by a separator.
- isEmpty: Test whether a list is empty.
- itoString: Convert a list to an indented string.
- last: Return the last element of a list, if any.
- lastIndexOf: Return index of last occurrence of elt in lst, or -1 if elt is not found.
- mapper: Apply a function to all list elements and return list of results.
- max: Determine the largest element in a list.
- merge: Merge the elements of two sorted lists into one list.
- min: Determine the smallest element in a list.
- mix: Mix the elements of two lists.
- permutations: Compute all permutations of a list.
- pop: Pop top element from list, return a tuple.
- prefix: Return all but the last element of a list.
- push: Push an element in front of a list.
- reducer: Apply a function to successive elements of list and combine the results (deprecated).
- reverse: Reverse a list.
- size: Determine the number of elements in a list.
- slice: Compute a sublist of a list.
- sort: Sort the elements of a list.
- split: Split a list into two halves.
- sum: Sum the elements of a list.
- tail: Get the tail element(s) from a list.
- take: Get number of elements from the head of a list.
- takeOneFrom: Remove an arbitrary element from a list, returns the element and the modified list.
- takeWhile: Take elements from the front of the list as long as a predicate is true.
- toMap: Convert a list of pairs to a map; first elements are associated with a set of second elements.
- toMapUnique: Convert a list of tuples to a map; result must be a map.
- top: Take the top element of a list.
- toRel: Convert a list to a relation.
- toSet: Convert a list to a set.
- toString: Convert a list to a string.
- unzip: Make a pair (triple) of lists from a list of pairs (triples).
- upTill: Returns the list 0,1..n-1.
- zip: Make a list of pairs from two (three) lists of the same length.
- ListRelation:
- carrier: Return the set of all elements in any tuple in a list relation.
- carrierR: A list relation restricted to certain element values in tuples.
- carrierX: A list relation excluding tuples that contain certain element values.
- complement: Complement of a list relation.
- domain: Domain of a list relation: a list consisting of the first element of each tuple.
- domainR: List relation restricted to certain domain elements.
- domainX: List relation excluding certain domain values.
- groupDomainByRange: Make sets of elements in the domain that relate to the same element in the range.
- groupRangeByDomain: Make sets of elements in the range that relate to the same element in the domain.
- ident: The identity list relation.
- index: Listes a binary list relation as a map
- invert: Invert the tuples in a list relation.
- range: The range (i.e., all but the first element of each tuple) of a list relation.
- rangeR: List relation restricted to certain range values.
- rangeX: List relation excluding certain range values.
- Map:
- delete: Delete a key from a map.
- domain: Determine the domain (set of keys) of a map.
- domainR: Map restricted to certain keys.
- domainX: Map with certain keys excluded.
- getOneFrom: Get a n arbitrary key from a map.
- invert: Invert the (key,value) pairs in a map.
- invertUnique: Invert the (key,value) pairs in a map.
- isEmpty: Test whether a map is empty.
- itoString: Convert a map to a indented string.
- mapper: Apply a function to all (key, value) pairs in a map.
- range: The range (set of values that correspond to its keys) of a map.
- rangeR: Map restricted to certain values in (key,values) pairs.
- rangeX: Map with certain values in (key,value) pairs excluded.
- size: Number of (key, value) pairs in a map.
- toList: Convert a map to a list of tuples.
- toRel: Convert a map to a relation.
- toString: Convert a map to a string.
- Message: A
Message datatype that represents messages in the IDE.
- Node:
- ParseTree: Library functions for parse trees.
- associativity: Choice under associativity is flattened.
- Condition: constructors for declaring preconditions and postconditions on symbols
- doc: Annotate a parse tree node with a documentation string.
- docs: Annotate a parse tree node with documentation strings for several locations.
- implode: Implode a parse tree according to a given (ADT) type.
- isNonTerminalType:
- link: Annotate a parse tree node with the target of a reference.
- links: Annotate a parse tree node with multiple targets for a reference.
- loc: Annotate a parse tree node with a source location.
- message: Annotate a parse tree node with an (error) message.
- messages: Annotate a parse tree node with a list of (error) messages.
- parse: Parse input text (from a string or a location) and return a parse tree.
- priority: Nested priority is flattened.
- Production:
- saveParser: Save the current object parser to a file.
- Symbol:
- Tree: The Tree data type as produced by the parser.
- treeAt: Select the innermost Tree of a given type which is enclosed by a given location.
- TreeSearchResult: Tree search result type for treeAt.
- unparse: Yield the string of characters that form the leafs of the given parse tree.
- Relation:
- carrier: Return the set of all elements in any tuple in a relation.
- carrierR: A relation restricted to certain element values in tuples.
- carrierX: A relation excluding tuples that contain certain element values.
- complement: Complement of a relation.
- domain: Domain of a relation: a set consisting of the first element of each tuple.
- domainR: Relation restricted to certain domain elements.
- domainX: Relation excluding certain domain values.
- groupDomainByRange: Make sets of elements in the domain that relate to the same element in the range.
- groupRangeByDomain: Make sets of elements in the range that relate to the same element in the domain.
- ident: The identity relation.
- index: Indexes a binary relation as a map
- invert: Invert the tuples in a relation.
- range: The range (i.e., all but the first element of each tuple) of a relation.
- rangeR: Relation restricted to certain range values.
- rangeX: Relation excluding certain range values.
- Set: Library functions for sets.
- classify: Classify elements in a set.
- getOneFrom: Pick a random element from a set.
- group: Group elements in a set given an equivalence function.
- index: Map set elements to a fixed index.
- isEmpty: Test whether a set is empty.
- itoString: Convert a set to an indented string.
- mapper: Apply a function to all set elements and return set of results.
- max: Determine the largest element of a set.
- min: Smallest element of a set.
- power: Determine the powerset of a set.
- power1: The powerset (excluding the empty set) of a set value.
- reducer: Apply a function to successive elements of a set and combine the results (deprecated).
- size: Determine the number of elements in a set.
- sort: Sort the elements of a set. Sort the elements of a set: # Use the built-in ordering on values to compare list elements. # Give an additional
lessThan function that will be used to compare elements. This function lessThan (<) function should implement a strict partial order, meaning: # that it is not reflexive, i.e. never a < a # is anti-symmetric, i.e. never a < b && b < a . # is transitive, i.e. if a < b and b < c then a < c .
- sum: Sum the elements of a set.
- takeOneFrom: Remove an arbitrary element from a set, returns the element and a set without that element.
- toList: Convert a set to a list.
- toMap: Convert a set of tuples to a map; each key is associated with a set of values.
- toMapUnique: Convert a set of tuples to a map (provided that there are no multiple keys).
- toString: Convert a set to a string.
- union: flatten a set of sets into a single set.
- String:
- center: Center a string in given space.
- charAt: Return character in a string by its index position.
- chars: Return characters of a string.
- contains: Check that a string contains another string.
- endsWith: Check whether a string ends with a given substring.
- escape: Replace single characters in a string.
- findAll: Find all occurrences of a string in another string.
- findFirst: Find the first occurrence of a string in another string.
- findLast: Find the last occurrence of a string in another string.
- isEmpty: Check whether a string is empty.
- isValidCharacter: Check that a given integer value is a valid Unicode code point.
- left: Left alignment of string in given space.
- replaceAll: Replace all occurrences of a string in another string.
- replaceFirst: Replace the first occurrence of a string in another string.
- replaceLast: Replace the last occurrence of a string in another string.
- reverse: Return a string with all characters in reverse order.
- rexpMatch: Determine if a string matches the given (Java-syntax) regular expression.
- right: Right align s in string of length n using space.
- size: Determine length of a string value.
- split: Split a string into a list of strings based on a literal separator.
- squeeze: Squeeze repeated occurrences of characters.
- startsWith: Check whether a string starts with a given prefix.
- stringChar: Convert a character code into a string.
- stringChars: Convert a list of character codes into a string.
- substring: Extract a substring from a string value.
- toInt: Convert a string value to integer.
- toLocation: Convert a string value to a (source code) location.
- toLowerCase: Convert the characters in a string value to lower case.
- toReal: Convert a string value to real.
- toUpperCase: Convert the characters in a string value to upper case.
- trim: Returns string with leading and trailing whitespace removed.
- wrap: word wrap a string to fit in a certain width.
- Type: This is a module that reflects Rascal's type system, implemented in Rascal itself.
- Attr: Attributes register additional semantics annotations of a definition.
- choice: Choice between alternative productions.
- comparable: Check if two types are comparable, i.e., have a common supertype.
- eq: structural equality between values.
- equivalent: Check if two types are equivalent.
- Exception:
- glb: The greatest lower bound (glb) between two types.
- isADTType: Determine if the given type is an Abstract Data Type (ADT).
- isAliasType: Determine if the given type is an alias.
- isBagType: Determine if the given type is a bag (bags are not yet implemented).
- isBoolType: Determine if the given type is a bool.
- isConstructorType: Determine if the given type is a constructor.
- isDateTimeType: Determine if the given type is a
datetime .
- isFunctionType: Determine if the given type is a function.
- isIntType: Determine if the given type is an int.
- isListRelType: Determine if the given type is a list relation.
- isListType: Determine if the given type is a list.
- isLocType: Determine if the given type is a loc.
- isMapType: Determine if the given type is a map.
- isNodeType: Determine if the given type is a node.
- isNumType: Determine if the given type is a num.
- isRatType: Determine if the given type is a rational.
- isRealType: Determine if the given type is a real.
- isReifiedType: Determine if the given type is a reified type.
- isRelType: Determine if the given type is a relation.
- isSetType: Determine if the given type is a set.
- isStrType: Determine if the given type is a string.
- isTupleType: Determine if the given type is a tuple.
- isTypeVar: Determine if the given type is an type variable (parameter).
- isValueType: Determine if the given type is a value.
- isVoidType: Determine if the given type is a void.
- lub: The least-upperbound (lub) between two types.
- make: instantiate an ADT constructor of a given type with the given children
- Production: A production in a grammar or constructor in a data type.
- subtype:
- Symbol: A Symbol represents a Rascal Type.
- typeOf: returns the dynamic type of a value as a reified type
- var-func:
- ValueIO: Library functions for reading and writing values in textual and binary format.
- util: Utilities: functions, data types and interfaces with external libraries.
- Benchmark: Functions for time measurement and benchmarking.
- benchmark: Measure and report the execution time of name:void-closure pairs
- cpuTime: CPU time in nanoseconds (10
-9 sec).
- gc: Force a garbage collection.
- getMilliTime: Current time in milliseconds (10
-3 sec) since January 1, 1970 GMT.
- getNanoTime: Current time in nanoseconds (10
-9 sec) since January 1, 1970 GMT.
- realTime: Current time in milliseconds (10
-3 sec).
- systemTime: System time in nanoseconds (10
-9 sec).
- userTime: User time in nanoseconds (10
-9 sec).
- Clipboard: access to the system’s copy and paste clipboard
- copy: copy a value to the user's clipboard
- paste: copy a value to the user's clipboard
- ContentCompletion:
- Editors:
- Eval:
- eval: Evaluate a (list of) Rascal commands and return the value of the last command.
- evalType: Evaluate a (list of) Rascal commands and return the type of the last command.
- Result:
- IDE: Extend an IDE with interactive, language-specific, features (Eclipse only).
- Math: Mathematical functions.
- abs: Absolute value of a number.
- arbInt: Generate a random integer value.
- arbRat: Generate an arbitrary rational value.
- arbReal: Generate a random real value in the interval [0.0,1.0).
- arbSeed: Define the seed for the generation of arbitrary values.
- ceil: Compute the smallest integer that is larger than a given number.
- cos: Calculate the cosine of a numeric value.
- denominator: Return the denominator of a rational value.
- E: The constant E.
- exp: Compute exp(x).
- floor: Compute the largest integer that is smaller than a given number.
- ln: Calculate the natural log of a numeric value.
- log: Calculate the logbase of a numeric value.
- log10: Compute the 10 based log(x).
- log2: Compute the 2 based log(x).
- max: Determine the largest of two numeric values.
- min: Determine the smallest of two numeric values.
- nroot: Calculate the nth root of a numeric value.
- numerator: Return the numerator of a rational value.
- percent: Compute the ratio between two numbers as a percentage.
- PI: The constant pi.
- pow: Calculate an arbitrary power of a numeric value.
- precision: Return the precision of a real number.
- primes: generate prime numbers up to a maximum
- remainder: Return the remainder of dividing the numerator by the denominator.
- round: Round a number to the nearest multiple of a given number (default 1).
- scale: Return the scale of a real number.
- setPrecision: Define the precision for numeric calculations; returns the previous precision.
- sin: Calculate the sine of a numeric value.
- sqrt: Calculate the square root of a numeric value.
- tan: Calculate the tangent of a numeric value.
- toInt: Convert a numeric value to an integer.
- toRat: Convert two numbers to a rational value (not supported on reals).
- toReal: Convert a numeric value to a real.
- toString: Convert a numeric value to a string.
- unscaled: Return the unscaled integer of a real.
- Maybe: Data type to represent an optional value.
- Monitor: Monitor the progress of a task/job
- endJob: Log the end of a job.
- event: Log the start of an event (it is ended by another
event or by endJob ).
- startJob: Log the start of a job.
- todo: Set the estimated remaining work for the current (sub)job.
- ParseTreeUI:
- PriorityQueue: A
PriorityQueue datatype and associated functions.
- Prompt:
- ResourceMarkers:
- Resources: A
Resource datatype and related functions on Eclipse resources.
- dependencies: Compute the (transitive) dependencies of a project.
- getProject: Retrieve the hierarchical representation of a single named project.
- projects: Retrieve the set of project locations of the current Eclipse workspace.
- references: The set of projects that are referenced by a project.
- Resource:
- root: Retrieve a full hierarchical representation of all resources in the Eclipse workspace.
- ShellExec: Execute and manage external processes.
- createProcess: Start a new external process.
- killProcess: Kill a running process.
- PID: Process Identifiers (PID).
- readEntireErrStream: Read the entire error stream from an existing process's output stream. This is blocking.
- readEntireStream: Read the entire stream from an existing process's output stream. This is blocking.
- readFrom: Read from an existing process's output stream. This is non-blocking.
- readFromErr: Read from an existing process's error output stream. This is non-blocking.
- writeTo: Write to an existing process's input stream.
- SyntaxHighlightingTemplates:
- ValueUI:
- lang: Definitions and tools for various languages.
- csv: Comma-Separated Values (CSV).
- IO: Functions for reading and writing Comma-Separated Values (CSV) files.
- generate:
- readCSV: Read a relation from a CSV (Comma Separated Values) file.
- writeCSV: Write a relation to a CSV (Comma Separated Values) file.
- java: Definitions and tools related to the Java language.
- jdt: tools for Java provided via reusing the Eclipse JDT
- m3: functions for generating M3 models starting from Eclipse projects
- Core: create M3 models for Eclipse projects
- m3: Java-specific version of the M3 model
- RSF: Functions for reading/writing the Rigi Standard Format (RSF).
- readRSF: Read a file in Rigi Standard Format (RSF).
- xml: XML utilities
- DOM: Functions for reading and writing XML files.
- attribute: Auxiliary constructor for XML attribute without namespace.
- attrs:
- element: Auxiliary constructor for XML element without namespace.
- Node: Datatypes for representing an instance of the DOM.
- parseXMLDOM: Parse an XML document and return a DOM instance.
- parseXMLDOMTrim: Parse an XML document and trim it (remove layout).
- xmlCompact: Convert a DOM instance to a compact XML string (with minimal white space).
- xmlPretty: Convert a DOM instance to a pretty printed XML string.
- xmlRaw: Convert a DOM instance to a raw XML string.
- Vis: Functions for creating visualisations.
- Figure: Overview of the complete Figure library.
- Angles: Conventions for defining angles.
- ColorModel: The model used for defining colors.
- arbColor: Creates an arbitrary color.
- color: Return a color with a given name.
- colorNames: Sorted list of available color names that can be used by the color function.
- colorScale: Compute a color scale for range of values.
- colorSteps: Create a list of intermediate colors between two colors.
- gray: The color gray.
- interpolateColor: Interpolate between two colors.
- palette: A standard palette of 12 colors.
- rgb: Create a color from a
red , green and blue contribution.
- CompositionModel: The model for composing figures.
- Figures: Overview of all figures.
- box: A rectangular box.
- button: An interactive push button.
- checkbox: An interactive checkbox.
- choice: An interactive choice.
- combo: An interactive combo box.
- computeFigure: A dynamically computed figure.
- edge: An edge in a graph.
- ellipse: An ellipse.
- fswitch: Dynamic selection from a fixed list of figures.
- graph: Graph layout.
- grid: Place figures in a grid with cells of equal size.
- hcat: Horizontal composition of a list of figures.
- hscreen: Creates a horizontal screen on which things can be projected.
- hscrollable: Embed a figure in a horizontally scrollable plane.
- hvcat: Horizontal and vertical composition of a list of figures.
- LineDecoration: Describes the line decorations for an outline.
- outline: Outline to summarize file related information.
- overlay: Composition of figures by superposition.
- pack: Dense packing of a list of figures.
- rotate: Rotate a figure.
- scale: Scale a figure.
- scaleSlider: Interactive slider.
- scrollable: Embed a figure in a scrollable plane.
- space: An invisible space.
- text: Text.
- textfield: Interactive text entry field.
- tree: Tree layout.
- treemap: Treemap layout.
- vcat: Vertical composition of figures.
- vscreen: Vertical projection screen.
- vscrollable: Embded a figure in a vertically scrollable plane.
- InteractionModel: The model used for user-interaction.
- KeyModifier: The
KeyModifier datatype describes key modifiers in user-interactions.
- Properties: Overview of all visual properties that apply to figures.
- align: Alignment of figure relative to parent.
- area: The desired area for a figure inside a treemap.
- aspectRatio: The fixed aspect ratio of a figure.
- bottom: Bottom alignment.
- center: Centered alignment.
- connect: Connection point for figure in an overlay.
- endGap: End gap in composition.
- fillColor: Fill color.
- font: Define font to be used for text.
- fontBold: Define if text should be rendered bold.
- fontColor: Define the color to be used for text.
- fontItalic: Defines if text should be rendered italic.
- fontNames: The available font names.
- fontSize: Size of the font to be used for text.
- fromArrow: Arrow for source of an edge.
- gap: Define minimal gap between figures in compositions.
- grow: Grow (increase) the size of a figure relative to any contained figures.
- halign: Horizontal alignment.
- hcenter: Horizontal, centered, alignment.
- hconnect: Define horizontal connection point of figure in an overlay.
- height: Define the minimal vertical size.
- hendGap: Horizontal end gap in compositions.
- hgap: Define minimal horizontal gap in compositions.
- hgrow: Increase (grow) the horizontal size of a figure relative to contained figures.
- hint: Hint at layout algorithm to be used in graphs.
- hresizable: Resizable in horizontal direction.
- hshadowPos: Horizontal position of shadows.
- hshrink: Decrease (shrink) the size of a figure relative to its parent.
- hsize: Defines the minimal horizontal size.
- hstartGap: Horizontal gap at start of composition.
- ialign: Internal align in hvcat.
- id: Identity.
- justify: Justification in hvcat.
- KeySym: Datatype describing a key on the keyboard.
- label: A label on an edge.
- layer: A layer in a graph.
- left: Left, horizontal, alignment.
- lineColor: Defines the line color.
- lineStyle: Sets the style of lines and borders of figures.
- lineWidth: Defines the width of lines.
- manhattan: Define the drawing style of trees.
- mouseOver: Define interactive mouse over behaviour.
- onClick: Old name for onMouseDown. (deprecated)
- onKeyDown: Define interactive behaviour when a key is pressed.
- onKeyUp: Define interactive behaviour when key is released.
- onMouseDown: Define interactive behaviour when mouse is pressed while mouse is over figure.
- onMouseEnter: Define interactive behaviour when the mouse pointer enters the figure.
- onMouseExit: Define interactive behaviour when the mouse pointer leaves the figure.
- onMouseMove: Define interactive behaviour when the mouse moves over this figure.
- onMouseUp: Define interactive behaviour when the mouse button is released.
- orientation: Define the orientation of a tree or graph.
- project: Project figure on a hscreen or vscreen.
- resizable: Define whether figure can be resized.
- right: Right, horizontal, alignment.
- shadow: Add a shadow to the current figure.
- shadowColor: Define the color of a shadow.
- shadowPos: Define the position of a shadow.
- shapeClosed: Connect first and last point of a shape in an overlay.
- shapeConnected: Connect the figures in a shape by lines.
- shapeCurved: Connect the figures in a shape by curves.
- shrink: Decrease (shrink) the size of a figure relative to its parent.
- size: Define the minimal size of a figure.
- startGap: Define the gap at the start of a composition.
- std: Define a standard property value for all contained figures.
- textAngle: Define the angle at which text is drawn.
- timer: Define interactive, time-dependent, behaviour.
- toArrow: Add an error to the destination of an edge.
- top: Top, vertical, alignment.
- valign: Vertical alignment.
- vcenter: Vertical, centered, alignment.
- vconnect: Vertical connection point of a figure in an overlay.
- vendGap: Vertical gap at end of composition.
- vgap: Define minimal vertical gap in compositions.
- vgrow: Increase (grow) the vertical size of a figure relative to its contained figures.
- vresizable: Define whether figure is resizable in the vertical direction.
- vshadowPos: Vertical position of shadow.
- vshrink: Decrease (shrink) vertical size of figure relative to its parent.
- vsize: Define the minimal vertical size.
- vstartGap: Vertical gap at start of composition.
- width: Defines the minimal horizontal size.
- Render: Render a figure on screen or save it to a file.
- render: Render a figure on screen.
- renderSave: Render and save a figure to a file.
- TestVis: List of visualization tests (for developers only).
- analysis: Library functions for analysis tasks.
- formalconcepts: Library for Formal Concept Analysis
- FCA:
- fca: Computes Concept Lattice given the Object Attribute Relation.
- FormalContext: Data Types belonging to Formal Concept Analysis.
- toDot: Computes Dot Graph from Concept Lattice.
- graphs: Analyzing unlabeled and labelled graphs.
- Graph: A
Graph datatype with associated functions.
- bottom: Determine the bottom nodes (leaves) of a graph.
- connectedComponents: Determine the connected components of a graph.
- Graph:
- order: Compute topological order of the nodes in a graph.
- predecessors: Determine the direct predecessors of a graph node.
- reach: Determine the graph nodes reachable from a set of nodes.
- reachR: Determine the graph nodes reachable from a set of nodes using a restricted set of intermediate nodes.
- reachX: Determine the graph nodes reachable from a set of nodes excluding certain intermediate nodes.
- shortestPathPair: Determine the shortest path between two graph nodes.
- successors: Determine the direct successors of a graph node.
- top: Determine the set of top nodes (roots) of a graph.
- LabeledGraph:
- bottom: Return the bottom nodes of a LGraph.
- LGraph:
- predecessors: The predecessors of a single node in a LGraph.
- reach: Reachability from a given start set of nodes.
- reachR: Reachability from given start set of nodes with restrictions.
- reachX: Reachability from given start set of nodes with exclusions.
- successors: The successors of a single node in a LGraph.
- top: Return the top nodes of a LGraph.
- m3: a language independent meta model for facts about source code, which is extensible to include language specific modeling elements
- AST: a symbolic representation for abstract syntax trees of programming languages.
- Core: M3 common source code model represent facts extracted from source code for use in downstream metrics or other analyses.
- Registry: in memory database for analysis/m3/Core models for resolving hyperlinks
- TypeSymbol: a symbolic representation for types that occur in programming languages.
- statistics: Statistical functions.
- Frequency: Frequency distributions.
- cumFreq: Cumulative frequency of values less than or equal to a given value.
- cumPct: Cumulative percentage of values less than or equal to a given value.
- distribution: Compute a distribution: count how many times events are mapped to which bucket.
- pct: Percentage of values that are equal to a given value.
- Descriptive: Descriptive Statistics.
- Correlation: Correlation between data values.
- Inference: Statistical inference methods.
- SimpleRegression:
|