Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Update "use" and "borrow" statements in comments #860

Merged
merged 2 commits into from
Nov 23, 2021
Merged

Update "use" and "borrow" statements in comments #860

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c6bcdb
Update "use" and "borrow" statements in comments
tcNickolas Oct 26, 2021
2aba8b0
Merge branch 'main' into tcNickolas-patch-1
bettinaheim Nov 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Simulation/Common/IQuantumProcessor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ public interface IQuantumProcessor
void OnFail(System.Runtime.ExceptionServices.ExceptionDispatchInfo exceptionDispatchInfo);

/// <summary>
/// Called when qubits are allocated by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>using</c></a> block.
/// Called when qubits are allocated by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>use</c></a> block.
/// </summary>
/// <param name="qubits">Qubits that are being allocated</param>.
/// <remarks>
Expand All @@ -573,7 +573,7 @@ public interface IQuantumProcessor
void OnAllocateQubits(IQArray<Qubit> qubits);

/// <summary>
/// Called when qubits are released in Q# in the end of <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>using</c></a> block.
/// Called when qubits are released in Q# in the end of <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#use-statement"><c>use</c></a> block.
/// </summary>
/// <param name="qubits">Qubits that are being released</param>.
/// <remarks>
Expand All @@ -583,7 +583,7 @@ public interface IQuantumProcessor
void OnReleaseQubits(IQArray<Qubit> qubits);

/// <summary>
/// Called when qubits are borrowed by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrowing</c></a> block.
/// Called when qubits are borrowed by Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrow</c></a> block.
/// </summary>
/// <param name="qubits">Qubits that are being borrowed</param>.
/// <param name="allocatedForBorrowingCount">Number of qubits that have been allocated for borrowing. This might happen if there have not been enough already allocated qubits available for borrowing.</param>.
Expand All @@ -594,7 +594,7 @@ public interface IQuantumProcessor
void OnBorrowQubits(IQArray<Qubit> qubits, long allocatedForBorrowingCount);

/// <summary>
/// Called when qubits are returned in the end of Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrowing</c></a> block.
/// Called when qubits are returned in the end of Q# <a href="https://docs.microsoft.com/azure/quantum/user-guide/language/statements/quantummemorymanagement#borrow-statement"><c>borrow</c></a> block.
/// </summary>
/// <param name="qubits">Qubits that have been borrowed and are now being returned</param>.
/// <param name="releasedOnReturnCount">Number of qubits that have been released once returned. This might happen if they have been allocated only for borrowing.</param>.
Expand Down