Math2mat
Public Member Functions

m2m.backend.buildingblocks.blocks.MuxComb32 Class Reference

Inheritance diagram for m2m.backend.buildingblocks.blocks.MuxComb32:
Inheritance graph
[legend]
Collaboration diagram for m2m.backend.buildingblocks.blocks.MuxComb32:
Collaboration graph
[legend]

List of all members.

Public Member Functions

String vhdlFileName ()
ImplType implType ()
int latencyTime ()
int cycleTime ()
int resources ()
int period ()
String functionName ()
String entityName ()
String author ()
int version ()
String description ()
ArrayList< String > dependentFiles ()

Detailed Description

Definition at line 26 of file MuxComb32.java.


Member Function Documentation

String m2m.backend.buildingblocks.blocks.MuxComb32.author ( ) [virtual]

Returns the author of the VHDL file.

Returns:
the author name

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 69 of file MuxComb32.java.

int m2m.backend.buildingblocks.blocks.MuxComb32.cycleTime ( )

Indicates the cycle time of the building block. For a standard pipeline implementation, it should be 1, as a new calculation can be launched at every clock cycle. For a sequential implementation it should return the number of clock cycles required for a processing, if this is known, 0 else. For a combinatorial implementation, it is not relevant.

Returns:
the cycle time

Reimplemented from m2m.backend.buildingblocks.BuildingBlock.

Definition at line 44 of file MuxComb32.java.

ArrayList<String> m2m.backend.buildingblocks.blocks.MuxComb32.dependentFiles ( ) [virtual]

Returns the names of the VHDL files the block needs.

Returns:
Names of dependent VHDL files.

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 84 of file MuxComb32.java.

String m2m.backend.buildingblocks.blocks.MuxComb32.description ( ) [virtual]

Returns a description of the building block. It can then be exploited to display a list of available components.

Returns:
a description of the block

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 79 of file MuxComb32.java.

String m2m.backend.buildingblocks.blocks.MuxComb32.entityName ( ) [virtual]

Returns the name of the VHDL entity describing the block.

Returns:
the name of the VHDL entity

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 64 of file MuxComb32.java.

String m2m.backend.buildingblocks.blocks.MuxComb32.functionName ( ) [virtual]

Returns the name of the function implemented by the block. All blocks performing the same function should return the same name. It has to be fixed for the operators, and can be user defined for functions.

The basic functions HAVE to respect there names:

  • multiplication: mult
  • division: div
  • addition: add
  • subtraction: sub
  • square root: sqrt
  • exponential: exp

Other functions can be added, such as sin, cos, ... The name returned by functionName() should then be the same as the one used in the mathematical source code.

Returns:
the name of the function calculated by the block

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 59 of file MuxComb32.java.

ImplType m2m.backend.buildingblocks.blocks.MuxComb32.implType ( ) [virtual]

Returns the implementation type, that can be SEQUENTIAL, PIPELINE, or COMBINATORIAL. It may help the optimizer to choose the most appropriate component for a given application.

Returns:
The implementation type

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 34 of file MuxComb32.java.

int m2m.backend.buildingblocks.blocks.MuxComb32.latencyTime ( )

Indicates the latency time of the building block. For a pipeline implementation, it returns the number of pipe stages, while for a sequential implementation it returns the number of clock cycles required for a processing, if this time is known, 0 else. For a combinatorial implementation it returns 1.

Returns:
the latency time

Reimplemented from m2m.backend.buildingblocks.BuildingBlock.

Definition at line 39 of file MuxComb32.java.

int m2m.backend.buildingblocks.blocks.MuxComb32.period ( ) [virtual]

Indicates the minimum period at which the block is functional. This value is relative to the other building blocks.

Returns:
an evaluation of the minumum period required

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 54 of file MuxComb32.java.

int m2m.backend.buildingblocks.blocks.MuxComb32.resources ( ) [virtual]

Indicates a hardware resources evaluation of the block. This value is relative to the other building blocks.

Returns:
an evaluation of the hardware resources required

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 49 of file MuxComb32.java.

int m2m.backend.buildingblocks.blocks.MuxComb32.version ( ) [virtual]

Returns the version number of the building block.

Returns:
the version number, as an integer

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 74 of file MuxComb32.java.

String m2m.backend.buildingblocks.blocks.MuxComb32.vhdlFileName ( ) [virtual]

Returns the name of the VHDL file in which the block is described.

Returns:
the name of the VHDL file

Implements m2m.backend.buildingblocks.BuildingBlock.

Definition at line 29 of file MuxComb32.java.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations