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

A
	add collection deque route route_node set tree tree_node
	add_all, collection
	add_delay, kitchen_timer
	add_first, deque
	add_last, deque
	add_to_node route tree
	alternate, bit_stream
	append dynamic_array queue
C
	capitalize, text
	center, text
	change, text
	chomp, text
	chop, text
	clear collection deque route set tree
	clone deque dynamic_array pair queue route set tree tuple
	colorize, text
	compare dynamic_array queue unpacked_array
	concat dynamic_array queue
	connect route route_node
	constant, data_stream
	contains collection deque set text
	contains_all, collection
	contains_str, text
	count, text
	count_hizs bit_stream packed_array
	count_ones bit_stream packed_array
	count_unknowns bit_stream packed_array
	count_zeros bit_stream packed_array
	crc, crc
	crc1, crc
	crc10, crc
	crc10_cdma2000, crc
	crc11, crc
	crc12, crc
	crc12_cdma2000, crc
	crc13_bbc, crc
	crc15_can, crc
	crc15_mpt1327, crc
	crc16_arinc, crc
	crc16_ccitt, crc
	crc16_cdma2000, crc
	crc16_dect, crc
	crc16_dnp, crc
	crc16_ibm, crc
	crc16_t10_dif, crc
	crc17_can, crc
	crc21_can, crc
	crc24, crc
	crc24_radix_64, crc
	crc30, crc
	crc32, crc
	crc32c, crc
	crc32k, crc
	crc32q, crc
	crc4_itu, crc
	crc40_gsm, crc
	crc5_epc, crc
	crc5_itu, crc
	crc5_usb, crc
	crc6_cdma2000_a, crc
	crc6_cdma2000_b, crc
	crc6_itu, crc
	crc64_ecma, crc
	crc64_iso, crc
	crc7, crc
	crc7_mvb, crc
	crc8, crc
	crc8_ccitt, crc
	crc8_dallas_maxim, crc
	crc8_sae_j1850, crc
	crc8_wcdma, crc
	csv, journal

virtual function bit add( T e )

(VIRTUAL) Adds the given element.

virtual function bit add( T e )

(VIRTUAL) Adds the given element at the end of this deque.

virtual function bit add( T e )

(VIRTUAL) Creates a new route_node of the given element and adds it to the start.

virtual function route_node_type add( T e )

(VIRTUAL) Creates a route node of the given element and adds it as a new to_nodes.

virtual function bit add( T e )

(VIRTUAL) Adds the given element to this set if it is not already present.

virtual function bit add( T e )

(VIRTUAL) Creates a new tree_node of the given element and adds it to the root.

virtual function tree_node_type add( T e )

(VIRTUAL) Creates a tree node of the given element and adds it as a new child.

virtual function bit add_all( collection#( T ) c )

(VIRTUAL) Adds all of the elements in the given collection to this collection.

function void add_delay( time delay )

Adds the specified delay.

virtual function void add_first( T e )

(VIRTUAL) Adds the given element at the front of this deque.

virtual function void add_last( T e )

(VIRTUAL) Adds the given element at the end of this deque.

virtual function route_node_type add_to_node( T e,
route_node_type node = null )

(VIRTUAL) Creates a new route_node of the given element and adds it to the specified node.

virtual function tree_node_type add_to_node( T e,
tree_node_type parent = null )

(VIRTUAL) Creates a new tree_node of the given element and adds it to the tree as the child of the specified parent.

static function bs_type alternate( int unsigned length,
T init_value = 0,
bit randomize_init_value = 0 )

(STATIC) Returns a new bit stream with the elements whose values alternate between 0 and 1.

static function da_type append( da_type da,
T e )

(STATIC) Appends the specified element to the given dynamic array.

static function q_type append( q_type q,
T e )

(STATIC) Appends the specified element to the given queue.

static function string capitalize( string s )

(STATIC) Returns a copy of the given string with the first character uppercased and the remainder lowercased.

static function string center( string s,
int width,
byte fill_char = " ",
bit trim_ends = 0 )

(STATIC) Returns a string of the specified width with the given string centerted and padded with the specified character.

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

(STATIC) Returns a copy of the given string with the characters in the specified range replaced with the specified substring.

static function string chomp( string s )

(STATIC) Returns a copy of the given string with the last newline character removed (if present).

static function byte chop( string s )

(STATIC) Returns the last character of the given string.

virtual function void clear()

(VIRTUAL) Removes all of the elements from this collection.

virtual function void clear()

(VIRTUAL) Removes all of the elements from this deque.

virtual function void clear()

(VIRTUAL) Removes all of the elements from this route.

virtual function void clear()

(VIRTUAL) Removes all of the elements from this set.

virtual function void clear()

(VIRTUAL) Removes all of the elements from this tree.

virtual function collection#( T ) clone()

(VIRTUAL) Returns a shallow copy of this deque.

static function da_type clone( da_type da )

(STATIC) Returns a copy of the given dynamic array.

function this_type clone()

Creates a pair by cloning this object.

static function q_type clone( q_type q )

(STATIC) Returns a copy of the given queue.

virtual function collection#( T ) clone()

(VIRTUAL) Returns a shallow copy of this route.

virtual function collection#( T ) clone()

(VIRTUAL) Returns a shallow copy of this set.

virtual function collection#( T ) clone()

(VIRTUAL) Returns a shallow copy of this tree.

function this_type clone()

Creates a tuple by cloning this object.

static function string colorize( string s,
fg_color_e fg = FG_BLACK,
bg_color_e bg = BG_WHITE,
bit bold = 0,
bit underline = 0,
bit blink = 0,
bit reverse = 0 )

(STATIC) Returns a copy of the given string with ANSI escape codes.

static function bit compare( const ref da_type da1,
const ref da_type da2,
input int from_index1 = 0,
int to_index1 = -1,
int from_index2 = 0,
int to_index2 = -1,
comparator#(T) cmp = null )

(STATIC) Compares two dynamic arrays.

static function bit compare( const ref q_type q1,
const ref q_type q2,
input int from_index1 = 0,
int to_index1 = -1,
int from_index2 = 0,
int to_index2 = -1,
comparator#(T) cmp = null )

(STATIC) Compares two queues.

static function bit compare( const ref ua_type ua1,
const ref ua_type ua2,
input int from_index1 = 0,
int to_index1 = -1,
int from_index2 = 0,
int to_index2 = -1,
comparator#(T) cmp = null )

(STATIC) Compares two unpacked arrays.

static function da_type concat( da_type da0,
da_type da1 )

(STATIC) Concatenates two dynamic arrays into one.

static function q_type concat( q_type q0,
q_type q1 )

(STATIC) Concatenates two queues into one.

virtual function route_node_type connect( route_node_type from_node,
route_node_type to_node )

(VIRTUAL) Connects the given two route_nodes.

virtual function route_node_type connect( route_node_type rn )

(VIRTUAL) Connects the given route node (and its connections) as a new to_nodes.

static function ds_type constant( int unsigned length,
pa_type value = 0,
bit randomize_value = 0 )

(STATIC) Returns a new data stream with the elements whose values are initiazlized with the specified constant.

virtual function bit contains( T e )

(VIRTUAL) Returns 1 if this collection contains the specified element.

virtual function bit contains( T e )

(VIRTUAL) Returns 1 if this deque contains the specified element.

virtual function bit contains( T e )

(VIRTUAL) Returns 1 if this set contains the specified element.

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

(STATIC) Returns 1 if the given string contains the specified substring.

virtual function bit contains_all( collection#( T ) c )

(VIRTUAL) Returns 1 if this collection contains all of the elements in the specified collection.

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

(STATIC) If the given string contains the specified substring, returns that substring.

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

(STATIC) Returns the number of non-overlapping occurrences of the specified substring in the given string.

static function int count_hizs( bs_type bs )

(STATIC) Counts the number of bit-stream items having value Z.

static function int count_hizs( pa_type pa )

(STATIC) Counts the number of bits having value Z.

static function int count_ones( bs_type bs )

(STATIC) Counts the number of bit-stream items having value 1.

static function int count_ones( pa_type pa )

(STATIC) Counts the number of bits having value 1.

static function int count_unknowns( bs_type bs )

(STATIC) Counts the number of bit-stream items having value X.

static function int count_unknowns( pa_type pa )

(STATIC) Counts the number of bits having value X.

static function int count_zeros( bs_type bs )

(STATIC) Counts the number of bit-stream items having value 0.

static function int count_zeros( pa_type pa )

(STATIC) Counts the number of bits having value 0.

static function T[63:0] crc( bs_type bs,
T[63:0] tap,
int degree )

(STATIC) Returns a CRC value using the specified taps.

static function T crc1( bs_type bs )

(STATIC) Returns a CRC-1 value; also known as a parity bit.

static function T[9:0] crc10( bs_type bs )

(STATIC) Returns a CRC-10 value.

static function T[9:0] crc10_cdma2000( bs_type bs )

(STATIC) Returns a CRC-10-CDMA2000 value.

static function T[10:0] crc11( bs_type bs )

(STATIC) Returns a CRC-11 value.

static function T[11:0] crc12( bs_type bs )

(STATIC) Returns a CRC-12 value.

static function T[11:0] crc12_cdma2000( bs_type bs )

(STATIC) Returns a CRC-12-CDMA2000 value.

static function T[12:0] crc13_bbc( bs_type bs )

(STATIC) Returns a CRC-13-BBC value.

static function T[14:0] crc15_can( bs_type bs )

(STATIC) Returns a CRC-15-CAN value.

static function T[14:0] crc15_mpt1327( bs_type bs )

(STATIC) Returns a CRC-15-MPT1327 value.

static function T[15:0] crc16_arinc( bs_type bs )

(STATIC) Returns a CRC-16-ARINC value.

static function T[15:0] crc16_ccitt( bs_type bs )

(STATIC) Returns a CRC-16-CCITT value.

static function T[15:0] crc16_cdma2000( bs_type bs )

(STATIC) Returns a CRC-16-CDMA2000 value.

static function T[15:0] crc16_dect( bs_type bs )

(STATIC) Returns a CRC-16-CECT value.

static function T[15:0] crc16_dnp( bs_type bs )

(STATIC) Returns a CRC-16-DNP value.

static function T[15:0] crc16_ibm( bs_type bs )

(STATIC) Returns a CRC-16-IBM value.

static function T[15:0] crc16_t10_dif( bs_type bs )

(STATIC) Returns a CRC-16-T10-DIF value.

static function T[16:0] crc17_can( bs_type bs )

(STATIC) Returns a CRC-17-CAN value.

static function T[20:0] crc21_can( bs_type bs )

(STATIC) Returns a CRC-21-CAN value.

static function T[23:0] crc24( bs_type bs )

(STATIC) Returns a CRC-24 value.

static function T[23:0] crc24_radix_64( bs_type bs )

(STATIC) Returns a CRC-24-Radix-64 value.

static function T[29:0] crc30( bs_type bs )

(STATIC) Returns a CRC-30 value.

static function T[31:0] crc32( bs_type bs )

(STATIC) Returns a CRC-32 value.

static function T[31:0] crc32c( bs_type bs )

(STATIC) Returns a CRC-32C (Castagnoli) value.

static function T[31:0] crc32k( bs_type bs )

(STATIC) Returns a CRC-32K (Koopman) value.

static function T[31:0] crc32q( bs_type bs )

(STATIC) Returns a CRC-32Q value.

static function T[3:0] crc4_itu( bs_type bs )

(STATIC) Returns a CRC-4-ITU value.

static function T[39:0] crc40_gsm( bs_type bs )

(STATIC) Returns a CRC-40-GSM value.

static function T[4:0] crc5_epc( bs_type bs )

(STATIC) Returns a CRC-5-EPC value.

static function T[4:0] crc5_itu( bs_type bs )

(STATIC) Returns a CRC-5-ITU value.

static function T[4:0] crc5_usb( bs_type bs )

(STATIC) Returns a CRC-5-USB value.

static function T[5:0] crc6_cdma2000_a( bs_type bs )

(STATIC) Returns a CRC-6-CDMA2000-A value.

static function T[5:0] crc6_cdma2000_b( bs_type bs )

(STATIC) Returns a CRC-6-CDMA2000-B value.

static function T[5:0] crc6_itu( bs_type bs )

(STATIC) Returns a CRC-6-ITU value.

static function T[63:0] crc64_ecma( bs_type bs )

(STATIC) Returns a CRC-64-ECMA value.

static function T[63:0] crc64_iso( bs_type bs )

(STATIC) Returns a CRC-64-ISO value.

static function T[6:0] crc7( bs_type bs )

(STATIC) Returns a CRC-7 value.

static function T[6:0] crc7_mvb( bs_type bs )

(STATIC) Returns a CRC-7-MVB value.

static function T[7:0] crc8( bs_type bs )

(STATIC) Returns a CRC-8 value.

static function T[7:0] crc8_ccitt( bs_type bs )

(STATIC) Returns a CRC-8-CCITT value.

static function T[7:0] crc8_dallas_maxim( bs_type bs )

(STATIC) Returns a CRC-8-Dallas/Maxim value.

static function T[7:0] crc8_sae_j1850( bs_type bs )

(STATIC) Returns a CRC-8-SAE-J1850 value.

static function T[7:0] crc8_wcdma( bs_type bs )

(STATIC) Returns a CRC-8-WCDMA value.

static function void csv( string desc,
string from_unit = "journal",
string to_unit = from_unit )

(STATIC) Stores a transaction to the file specified by the csv_fd using the CSV (comma separated value) format shown in the Example below.