Overview

Package Contents

Revision

v0.6.1

License

The MIT License (MIT)

Copyright © 2013, 2014, 2015, 2016 ClueLogic, LLC

http://cluelogic.com/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Some icons by Yusuke Kamiyamane.  Licensed under a Creative Commons Attribution 3.0 License.

Trademarks

  • Cadence is a registered trademark (#3474136) of Cadence Design Systems, Inc.
  • Incisive is a registered trademark (#2890264) of Cadence Design Systems, Inc.
  • Mentor is a registered trademark (#2388156) of Mentor Graphics Corporation.
  • ModelSim is a registered trademark (#2317058) of Mentor Graphics Corporation.
  • Questa is a registered trademark (#3308638) of Mentor Graphics Corporation.
  • Synopsys is a registered trademark (#1618482) of Synopsys, Inc.
  • VCS is a registered trademark (#2777162) of Synopsys, Inc.
  • IEEE is a registered trademark (#3666752) of The Institute of Electrical and Electronics Engineers, Inc.
virtual class text
Provides utility functions for text processing.
class pair#(type T1 =  int,
type T2 =  T1)
Provides a pair that carries two values, which can be different types.
class tuple#(type T1 =  int,
type T2 =  int,
type T3 =  int,
type T4 =  int,
type T5 =  int,
type T6 =  int,
type T7 =  int,
type T8 =  int,
type T9 =  int,
type T10 =  int)
Provides a tuple that carries up to ten values, which can be different types.
class tree_node #(type T =  int)
Implements a node of a tree.
class route_node #(type T =  int)
Implements a node of a route.
virtual class packed_array #(type T =  bit,
int WIDTH =  1)
A parameterized class that manages a packed array.
virtual class unpacked_array #(type T =  bit,
int SIZE =  1)
A parameterized class that manages an unpacked array.
virtual class dynamic_array #(type T =  bit,
int SIZE =  1)
A parameterized class that manages a dynamic array.
virtual class queue #(type T =  bit,
int SIZE =  1)
A parameterized class that manages a queue.
virtual class data_stream #(
   type T =  bit,
   int WIDTH =  1,
   int DEGREE =  2
) extends dynamic_array #( T[WIDTH-1:0] )
A parameterized class that manages a stream of packed arrays.
virtual class bit_stream #(type T =  bit) extends data_stream #( T, 1 )
A parameterized class that manages a bit stream.
virtual class collection#(type T =  int)
virtual Defines the core functionality of a collection.
virtual class set_base #(type T =  int) extends collection#( T )
virtual Defines the core functionality of a set.
class set #(type T =  int) extends set_base#( T )
Implements the set_base using an associative array.
class deque #(type T =  int) extends collection#( T )
Implements a double-ended queue using a queue.
class tree #(type T =  int) extends collection#( T )
Implements a tree structure.
class route #(type T =  int) extends collection#( T )
Implements a route structure.
virtual class iterator #(type T =  int)
virtual Defines a uniform way of accessing collection elements sequentially.
class set_iterator #(type T =  int) extends iterator#( T )
Provides an iterator to a set.
class deque_iterator #(type T =  int) extends iterator#( T )
Provides an iterator to a deque.
class deque_descending_iterator #(type T =  int) extends iterator#( T )
Provides an iterator to a deque in reverse order.
class tree_breadth_first_iterator #(type T =  int) extends iterator#( T )
Provides a breadth-first iterator to a tree.
class route_breadth_first_iterator #(type T =  int) extends iterator#( T )
Provides a breadth-first iterator to a route.
class comparator#(type T =  int)
singleton Provides strategies to compare objects.
class default_comparator#(type T =  int) extends comparator#(T)
singleton Provides the default strategies to compare objects.
class pair_comparator#(type T =  pair) extends comparator#(T)
singleton Provides strategies to compare pairs.
class tuple_comparator#(type T =  tuple) extends comparator#(T)
singleton Provides strategies to compare tuples.
class formatter #(type T =  int)
singleton Provides a strategy to convert an object of type T into a string.
class decimal_formatter #(type T =  int) extends formatter#( T )
singleton Provides a strategy to convert an object of integral data types such as int and time into a string using a decimal format.
class decimal_min_formatter #(type T =  int) extends formatter#( T )
singleton Provides a strategy to convert an object of integral data types such as int and time into a string using a decimal format with the minimum width.
class hex_formatter #(type T =  int) extends formatter#( T )
singleton Provides a strategy to convert an object of type T to a string using a hexadecimal format.
class hex_min_formatter #(type T =  int) extends formatter#( T )
singleton Provides a strategy to convert an object of type T to a string using a hexadecimal format with the minimum width.
class comma_formatter #(type T =  int) extends formatter#( T )
singleton Provides a strategy to convert an object of integral data types such as int and time into a string using a decimal format that has commas as thousands separators for better readability.
class string_formatter extends formatter#(string)
singleton Provides a strategy to convert an object of string data type into a string.
class kitchen_timer
Counts a simulation time (not a wall clock time) and triggers an event once the timer expires.
virtual class journal
virtual Provides logging functions to store transactions to a log or a CSV file.
virtual class crc #(type T =  bit)
virtual Provides functions to calculate a variety of CRC (cyclic redundancy check) values from a bit stream.
virtual class network
virtual Provides a logging function to store network transactions in the Wireshark hex format.
virtual class choice #(type T =  int)
virtual Provides functions to choose an item.
virtual class putil #(type T =  int)
virtual Provides a parameterized utility function.
virtual class util
virtual Provides several utility functions.