QsCompilation Class

Definition

Namespace:

Microsoft.Quantum.QsCompiler.SyntaxTree

Assembly:

Microsoft.Quantum.QsDataStructures.dll

Package:

Microsoft.Quantum.Compiler v0.25.218240

[Microsoft.FSharp.Core.CompilationMapping(Microsoft.FSharp.Core.SourceConstructFlags.RecordType)]
[System.Serializable]
public sealed class QsCompilation : IComparable, IComparable<Microsoft.Quantum.QsCompiler.SyntaxTree.QsCompilation>, IEquatable<Microsoft.Quantum.QsCompiler.SyntaxTree.QsCompilation>, System.Collections.IStructuralComparable, System.Collections.IStructuralEquatable

[<Microsoft.FSharp.Core.CompilationMapping(Microsoft.FSharp.Core.SourceConstructFlags.RecordType)>]
[<System.Serializable>]
type QsCompilation = {}

Public NotInheritable Class QsCompilation
Implements IComparable, IComparable(Of QsCompilation), IEquatable(Of QsCompilation), IStructuralComparable, IStructuralEquatable

Inheritance

Object

QsCompilation

Attributes

Microsoft.FSharp.Core.CompilationMappingAttribute SerializableAttribute

Implements

IStructuralComparable IStructuralEquatable IComparable IComparable<QsCompilation> IEquatable<QsCompilation>

Constructors

QsCompilation(ImmutableArray<QsNamespace>, ImmutableArray<QsQualifiedName>)

Properties

EntryPoints

Namespaces

Methods

CompareTo(Object)

CompareTo(Object, IComparer)

CompareTo(QsCompilation)

Equals(Object)

Equals(Object, IEqualityComparer)

Equals(QsCompilation)

GetHashCode()

GetHashCode(IEqualityComparer)

InteroperableSurface(Boolean)

ToString()

Extension Methods

InlineConjugations(QsCompilation, QsCompilation, Action<Exception>)

Eliminates all conjugations from the given compilation by replacing them with the corresponding implementations (i.e. inlining them). The generation of the adjoint for the outer block is subject to the same limitation as any adjoint auto-generation. In particular, it is only guaranteed to be valid if operation calls only occur within expression statements, and throws an InvalidOperationException if the outer block contains while-loops. Any thrown exception is logged using the given onException action and silently ignored if onException is not specified or null. Returns true if the transformation succeeded without throwing an exception, and false otherwise.

PreEvaluateAll(QsCompilation, QsCompilation, Action<Exception>)

Pre-evaluates as much of the classical computations as possible in the given compilation. Any thrown exception is logged using the given onException action and silently ignored if onException is not specified or null. Returns true if the transformation succeeded without throwing an exception, and false otherwise.