flopoco_wrapper.hpp File Reference

Wrapper to FloPoCo for VHDL code generation. More...

#include "custom_map.hpp"
#include "custom_set.hpp"
#include "dbgPrintHelper.hpp"
#include "exceptions.hpp"
#include "refcount.hpp"
#include "simple_indent.hpp"
#include "utility.hpp"
#include <string>
#include <vector>

Include dependency graph for flopoco_wrapper.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	flopoco_wrapper
	Main class for wrapping the FloPoCo code generator. More...

Namespaces
	flopoco
	Forward declarations of FloPoCo classes.

Macros
#define	FILE_EXT   ".vhdl"
	Default extension for generated files. More...
#define	ENCODE_NAME(FU_name, FU_prec_in, FU_prec_out, pipe_parameter)   ((FU_name) + "_" + STR(FU_prec_in) + "_" + STR(FU_prec_out) + ((pipe_parameter) != "" ? "_" + (pipe_parameter) : ""))
	Name of the stored Functional Unit. More...
#define	FLOPOCO_ADDITIONAL_BITS   2
	Additional bits in FloPoCo encoding with reference to IEEE-754 standard. More...
#define	IN_WRAP_PREFIX   "in_wrap_"
	Prefix for the wrapper to the inputs. More...
#define	OUT_WRAP_PREFIX   "out_wrap_"
	Prefix for the wrapper to the inputs. More...
#define	WRAPPED_PREFIX   "wrapped_"
	Suffix appended to the internal (wrapped) Functional Unit. More...

Typedefs
using	flopoco_wrapperRef = refcount< flopoco_wrapper >
	Refcount definition for the flopoco_wrapper class. More...

Functions
forward declarations
	REF_FORWARD_DECL (flopoco_wrapper)
	RefCount type definition of the flopoco_wrapper class structure. More...

Detailed Description

Wrapper to FloPoCo for VHDL code generation.

A object used to invoke the FloPoCo framework to generate VHDL code for floating-point functional units

Author

Daniele Mastrandrea danie.nosp@m.le.m.nosp@m.astra.nosp@m.ndre.nosp@m.a@mai.nosp@m.l.po.nosp@m.limi..nosp@m.it

Fabrizio Ferrandi fabri.nosp@m.zio..nosp@m.ferra.nosp@m.ndi@.nosp@m.polim.nosp@m.i.it $Date$ Last modified by $Author$

Definition in file flopoco_wrapper.hpp.

Macro Definition Documentation

ENCODE_NAME

#define ENCODE_NAME	(		FU_name,
			FU_prec_in,
			FU_prec_out,
			pipe_parameter
	)		((FU_name) + "_" + STR(FU_prec_in) + "_" + STR(FU_prec_out) + ((pipe_parameter) != "" ? "_" + (pipe_parameter) : ""))

Name of the stored Functional Unit.

Definition at line 64 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::add_FU(), flopoco_wrapper::get_FUPipelineDepth(), flopoco_wrapper::get_in_ports(), flopoco_wrapper::get_out_ports(), flopoco_wrapper::InternalWriteVHDL(), flopoco_wrapper::is_unit_written(), and flopoco_wrapper::writeVHDL().

FILE_EXT

#define FILE_EXT   ".vhdl"

Default extension for generated files.

Definition at line 62 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::is_unit_written(), flopoco_wrapper::writeVHDL(), and flopoco_wrapper::writeVHDLcommon().

FLOPOCO_ADDITIONAL_BITS

#define FLOPOCO_ADDITIONAL_BITS   2

Additional bits in FloPoCo encoding with reference to IEEE-754 standard.

Definition at line 67 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::outputPortDeclaration().

IN_WRAP_PREFIX

#define IN_WRAP_PREFIX   "in_wrap_"

Prefix for the wrapper to the inputs.

Definition at line 69 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::add_FU(), flopoco_wrapper::get_FUPipelineDepth(), flopoco_wrapper::outputPortMap(), and flopoco_wrapper::outputWrapVHDL().

OUT_WRAP_PREFIX

#define OUT_WRAP_PREFIX   "out_wrap_"

Prefix for the wrapper to the inputs.

Definition at line 71 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::add_FU(), flopoco_wrapper::get_FUPipelineDepth(), flopoco_wrapper::outputPortMap(), and flopoco_wrapper::outputWrapVHDL().

WRAPPED_PREFIX

#define WRAPPED_PREFIX   "wrapped_"

Suffix appended to the internal (wrapped) Functional Unit.

Definition at line 73 of file flopoco_wrapper.hpp.

Referenced by flopoco_wrapper::add_FU(), flopoco_wrapper::get_FUPipelineDepth(), flopoco_wrapper::get_in_ports(), flopoco_wrapper::get_out_ports(), flopoco_wrapper::outputPortMap(), flopoco_wrapper::outputSignals(), and flopoco_wrapper::outputWrapVHDL().

Typedef Documentation

flopoco_wrapperRef

using flopoco_wrapperRef = refcount<flopoco_wrapper>

Refcount definition for the flopoco_wrapper class.

Definition at line 295 of file flopoco_wrapper.hpp.

Function Documentation

REF_FORWARD_DECL()

REF_FORWARD_DECL

(

flopoco_wrapper

)

RefCount type definition of the flopoco_wrapper class structure.