ClueLib - Function Index

Function Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

G
	ge comparator pair tuple
	get, deque
	get_breadth_first_iterator route tree
	get_descending_iterator, deque
	get_elapsed, kitchen_timer
	get_first, deque
	get_index, route_node
	get_instance comma_formatter comparator decimal_formatter decimal_min_formatter formatter hex_formatter hex_min_formatter pair_comparator string_formatter tuple_comparator
	get_iterator collection deque route set tree
	get_last, deque
	get_last_node route tree
	get_location_name, tree
	get_num_children, tree_node
	get_num_of_to_nodes, route_node
	get_remaining, kitchen_timer
	get_state, kitchen_timer
	graft tree tree_node
	gt comparator default_comparator pair tuple
H
	has_child, tree_node
	has_next deque_descending_iterator deque_iterator iterator route_breadth_first_iterator set_iterator tree_breadth_first_iterator
	has_to_nodes, route_node
	hash, text
I
	index, text
	init dynamic_array packed_array queue unpacked_array
	insert, text
	is_alpha, text
	is_digit, text
	is_empty collection route set tree
	is_lower, text
	is_paused, kitchen_timer
	is_printable, text
	is_running, kitchen_timer
	is_single_bit_type, text
	is_space, text
	is_stopped, kitchen_timer
	is_upper, text

virtual function bit ge( T x,
T y )

(VIRTUAL) Returns 1 if x is greater than or equal to y.

function bit ge( const ref this_type p )

Returns 1 if this object is greater than or equal to the specified pair.

function bit ge( const ref this_type t )

Returns 1 if this object is greater than or equal to the specified tuple.

virtual function bit get( ref T e )

(VIRTUAL) Retrieves the head of the deque and remove the element.

virtual function iterator#( T ) get_breadth_first_iterator()

(VIRTUAL) Returns a route_breadth_first_iterator over the elements in this route.

virtual function iterator#( T ) get_breadth_first_iterator()

(VIRTUAL) Returns a tree_breadth_first_iterator over the elements in this tree.

virtual function iterator#( T ) get_descending_iterator()

(VIRTUAL) Returns an iterator over the elements in this deque in reverse order.

function time get_elapsed()

Returns the elapsed time since the timer was last started or resumed.

virtual function bit get_first( ref T e )

(VIRTUAL) Retrieves the head of the deque and remove the element.

virtual function int get_index( int from_node_index )

(VIRTUAL) Returns the index of the to_nodes this node is connected to, from the view point of the specified “from node”.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this comparator.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this comparator.

static function string_formatter get_instance()

(STATIC) Returns the singleton instance of this formatter.

static function this_type get_instance()

(STATIC) Returns the singleton instance of this comparator.

pure virtual function iterator#( T ) get_iterator()

(PURE) (VIRTUAL) Returns an iterator over the elements contained in this collection.

virtual function iterator#( T ) get_iterator()

(VIRTUAL) Returns an iterator over the elements in this deque.

virtual function iterator#( T ) get_iterator()

(VIRTUAL) Returns an iterator over the elements in this route.

virtual function iterator#( T ) get_iterator()

(VIRTUAL) Returns an iterator over the elements in this set.

virtual function iterator#( T ) get_iterator()

(VIRTUAL) Returns an iterator over the elements in this tree.

virtual function bit get_last( ref T e )

(VIRTUAL) Retrieves the tail of the deque and remove the element.

virtual function route_node_type get_last_node()

(VIRTUAL) Returns the last route node in the breadth-first order.

virtual function tree_node_type get_last_node()

(VIRTUAL) Returns the last tree node in the breadth-first order.

virtual function string get_location_name( tree_node_type tn )

(VIRTUAL) Returns the human-readable location string of this node from the root.

virtual function int get_num_children()

(VIRTUAL) Returns the number of (immediate) children of this tree node.

virtual function int get_num_of_to_nodes()

(VIRTUAL) Returns the number of to_nodes.

function time get_remaining()

Returns the remaining time to ring.

function state_e get_state()

Returns the current state of the timer.

virtual function tree_node_type graft( tree_node_type tn,
tree_node_type parent = null )

(VIRTUAL) Grafts the given tree_node (and its children) to the tree as the child of the specified parent.

virtual function tree_node_type graft( tree_node_type tn )

(VIRTUAL) Grafts the given tree node (and its children) as a new child.

virtual function bit gt( T x,
T y )

(VIRTUAL) Returns 1 if x is greater than y.

virtual function bit gt( T x,
T y )

(VIRTUAL) Returns 1 if x is greater than y.

function bit gt( const ref this_type p )

Returns 1 if this object is greater than the specified pair.

function bit gt( const ref this_type t )

Returns 1 if this object is greater than the specified tuple.

virtual function bit has_child()

(VIRTUAL) Returns if this tree node has at least one child.

virtual function bit has_next()

(VIRTUAL) Returns 1 if the iterator has more elements.

virtual function bit has_next()

(VIRTUAL) Returns 1 if the iterator has more elements.

pure virtual function bit has_next()

(PURE) (VIRTUAL) Returns 1 if the iteration has more elements.

virtual function bit has_next()

(VIRTUAL) Returns 1 if the iterator has more elements.

virtual function bit has_next()

(VIRTUAL) Returns 1 if the iterator has more elements.

virtual function bit has_next()

(VIRTUAL) Returns 1 if the iterator has more elements.

virtual function bit has_to_nodes()

(VIRTUAL) Returns if this route node has at least one to_nodes.

static function int hash( string s )

(STATIC) Returns the hash value of the given string.

static function int index( string s,
string sub,
int start_pos = 0,
int end_pos = -1 )

(STATIC) Returns the index of the first occurrence of the specified substring in the given string within the optionally specified range.

static function void init( ref da_type da,
input T val )

(STATIC) Initializes the each element of the given dynamic array to the specified value.

static function void init( ref pa_type pa,
input T val )

(STATIC) Initializes the each element of the given packed array to the specified value.

static function void init( ref q_type q,
input T val )

(STATIC) Initializes the each element of the given queue to the specified value.

static function void init( ref ua_type ua,
input T val )

(STATIC) Initializes the each element of the given unpacked array to the specified value.

static function string insert( string s,
string sub,
int start_pos = 0 )

(STATIC) Returns a copy of the given string with the specified substring inserted at the specified position.

static function bit is_alpha( string s )

(STATIC) Returns 1 if all characters in the given string are alphabetic.

static function bit is_digit( string s )

(STATIC) Returns 1 if all characters in the given string are digits.

virtual function bit is_empty()

(VIRTUAL) Returns 1 if this collection contains no elements.

virtual function bit is_empty()

(VIRTUAL) Returns 1 if this route contains no elements.

virtual function bit is_empty()

(VIRTUAL) Returns 1 if this set contains no elements.

virtual function bit is_empty()

(VIRTUAL) Returns 1 if this tree contains no elements.

static function bit is_lower( string s )

(STATIC) Returns 1 if all cased characters in the given string are lowercase.

function bit is_paused()

Returns 1 if the timer is currently paused.

static function bit is_printable( string s )

(STATIC) Returns 1 if all characters in the given string are printable.

function bit is_running()

Returns 1 if the timer is currently running.

static function bit is_single_bit_type( string s )

(STATIC) Returns 1 if the given string is bit, logic, or reg.

static function bit is_space( string s )

(STATIC) Returns 1 if all characters in the given string are whitespace characters: a space (“ “), a tab (\t), or a newline (\n).

function bit is_stopped()

Returns 1 if the timer is currently stopped.

static function bit is_upper( string s )

(STATIC) Returns 1 if all cased characters in the given string are uppercase.