List of all members | Public Member Functions | Public Attributes
write_specification_settings Struct Reference

Settings for write_specification. More...

Public Member Functions

 write_specification_settings ()
 Default constructor. More...
 

Public Attributes

std::string version
 A version string. More...
 
std::string header
 A header for the file. More...
 
std::vector< unsigned > output_order
 Order of literals in the output cubes. More...
 

Detailed Description

Settings for write_specification.

Author
RevKit
Since
1.0

Constructor & Destructor Documentation

Default constructor.

Initializes default values

Author
RevKit
Since
1.0

Member Data Documentation

std::string header

A header for the file.

This header will be printed as a comment in the first lines of the file. The string can be multi-line seperated by \n escape sequences. The comment character # can be omitted and will be inserted automatically.

Example

The following code creates a header in beginning of the file with author information.

settings.header = "Author: Test User\n(c) University";
write_specification( spec, "circuit.real", settings );
Author
RevKit
Since
1.0
std::vector<unsigned> output_order

Order of literals in the output cubes.

The order of the literals in the output cube can be changed with this vector. If not empty, it has to have the same size as the number of outputs in the specification.

It contains of distinct numbers from 0 to n-1, where n is the size of the input cubes. The numbers assign the literal in the output cube to that index. Empty indices (if the output cubes are smaller than the input cubes) are filled with don't care values.

Default value is an empty vector.

Author
RevKit
Since
1.0
std::string version

A version string.

Default value is 2.0 and printed after .version command

Author
RevKit
Since
1.0

The documentation for this struct was generated from the following file:

Generated on Tue Apr 16 2013 08:12:02 for RevKit by doxygen 1.8.3.1