Renders a circuit to both svg, for HTML, and tikz, for TeX.
Namespace: Microsoft.Research.LiquidAssembly: Liquid1 (in Liquid1.dll) Version: 1.0.5981.24943 (1.0.*)
Syntax member RenderHT :
file : string *
detail : FSharpOption<int> *
split : FSharpOption<float> *
scale : FSharpOption<float> -> unit
Parameters
- file
- Type: SystemString
The base name of the files to create.
Appropriate extensions will be added for the created files: ".htm" for the
SVG rendering, and ".tex" for the TikZ rendering. - detail
- Type: Microsoft.FSharp.CoreFSharpOptionInt32
An option specifying how many levels of Wrap to unwrap.
The default is 999. - split
- Type: Microsoft.FSharp.CoreFSharpOptionDouble
An option specifying what percentage of the total gates should go into each figure,
if the circuit won't fit into a single figure.
The default value varies with the figure size. - scale
- Type: Microsoft.FSharp.CoreFSharpOptionDouble
An option specifying a scaling percentage for the rendering, with 100.0 being full size.
The default value varies with the figure size.
Remarks
Detail is 0 for least, increasing wrap levels by each increment.
That is, at level 0 only the top-level gate of a Wrap is displayed;
at level 1, the top-level circuit that implements the Wrap is displayed;
at l;evel 2, the top-level circuit is displayed with its Wrap gates also
unwrapped once; etc.
See Also