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

Commit b8159a1

Browse files
authored
Update readme for removed .ll files (#814)
1 parent ef5d415 commit b8159a1

File tree

3 files changed

+20
-38
lines changed

3 files changed

+20
-38
lines changed

src/Qir/Runtime/lib/QIR/README.md

+14-21
Original file line numberDiff line numberDiff line change
@@ -17,50 +17,43 @@ Same-level entities are independent of each other (unless specified otherwise).
1717
**public\QirTypes.hpp** Defines `QirArray`, `QirString`, `PTuple`, `QirTupleHeader`, `TupleWithControls`, `QirCallable`, `QirRange`.
1818
Depends on the listed earlier ones.
1919

20-
**public\QirRuntime.hpp** Declares `quantum__rt__*()`. Depends on the listed earlier ones.
20+
**public\QirRuntime.hpp** Declares `__quantum__rt__*()`. Depends on the listed earlier ones.
2121

2222

2323
## Level 1
2424

2525
**allocationsTracker.hpp** Defines `Microsoft::Quantum::AllocationsTracker` that tracks the allocations and detects the mem leaks.
2626
Does not depend on anything of our code.
2727

28-
**utils.cpp** Implements `quantum__rt__fail()`, `quantum__rt__memory_allocate()`, `quantum__rt__heap_{alloc,free}()`.
29-
`quantum__rt__heap_alloc()` calls **strings.cpp**'s `quantum__rt__string_create()` - cyclical dependency.
28+
**utils.cpp** Implements `__quantum__rt__fail()`, `__quantum__rt__memory_allocate()`, `__quantum__rt__heap_{alloc,free}()`.
29+
`__quantum__rt__heap_alloc()` calls **strings.cpp**'s `__quantum__rt__string_create()` - cyclical dependency.
3030

31-
**strings.cpp** Implements `QirString`, `quantum__rt__string_*()`, `quantum__rt__<type>_to_string()` (except `qubit_to_string` and `result_to_string`).
32-
Depends on **utils.cpp**'s `quantum__rt__fail()` - cyclical dependency.
31+
**strings.cpp** Implements `QirString`, `__quantum__rt__string_*()`, `__quantum__rt__<type>_to_string()` (except `qubit_to_string` and `result_to_string`).
32+
Depends on **utils.cpp**'s `__quantum__rt__fail()` - cyclical dependency.
3333

3434

3535
## Level 2
3636

3737
**allocationsTracker.cpp** Implements the internals of `Microsoft::Quantum::AllocationsTracker`.
38-
Depends on `quantum__rt__fail()`, `quantum__rt__string_create()`
38+
Depends on `__quantum__rt__fail()`, `__quantum__rt__string_create()`
3939

4040
**context.cpp** Implements the internals of `Microsoft::Quantum::QirExecutionContext`,
4141
Depends on **allocationsTracker.hpp**'s `Microsoft::Quantum::AllocationsTracker`.
4242
Gets/returns `IRuntimeDriver *`.
4343

4444
## Level 3
4545

46-
**delegated.cpp** Implements `quantum__rt__result_*()`, `quantum__rt__qubit_{allocate,release,to_string}()`.
46+
**delegated.cpp** Implements `__quantum__rt__result_*()`, `__quantum__rt__qubit_{allocate,release,to_string}()`.
4747
Each API depends on `Microsoft::Quantum::GlobalContext()[->GetDriver()]`,
48-
`quantum__rt__qubit_to_string()` also depends on strings.cpp's `quantum__rt__string_create()`.
49-
`quantum__rt__result_to_string()` also depends on strings.cpp's `quantum__rt__string_create()`.
48+
`__quantum__rt__qubit_to_string()` also depends on strings.cpp's `__quantum__rt__string_create()`.
49+
`__quantum__rt__result_to_string()` also depends on strings.cpp's `__quantum__rt__string_create()`.
5050

51-
**arrays.cpp** Implements {the internals of `QirArray`} and `quantum__rt__*array*`.
52-
Depends on `Microsoft::Quantum::GlobalContext()`, `quantum__rt__fail()`, `quantum__rt__string_create()`,
53-
**delegated.cpp**'s `quantum__rt__qubit_allocate()`
51+
**arrays.cpp** Implements {the internals of `QirArray`} and `__quantum__rt__*array*`.
52+
Depends on `Microsoft::Quantum::GlobalContext()`, `__quantum__rt__fail()`, `__quantum__rt__string_create()`,
53+
**delegated.cpp**'s `__quantum__rt__qubit_allocate()`
5454

5555
## Level 4
5656

57-
**callables.cpp** Defines the {internals of `QirTupleHeader`, `QirCallable`}, `quantum__rt__tuple_*()`, `quantum__rt__callable_*()`
58-
Depends on `QirArray`, `Microsoft::Quantum::GlobalContext()`, `quantum__rt__fail()`, `quantum__rt__string_create()`, `TupleWithControls`,
57+
**callables.cpp** Defines the {internals of `QirTupleHeader`, `QirCallable`}, `__quantum__rt__tuple_*()`, `__quantum__rt__callable_*()`
58+
Depends on `QirArray`, `Microsoft::Quantum::GlobalContext()`, `__quantum__rt__fail()`, `__quantum__rt__string_create()`, `TupleWithControls`,
5959
Consider breaking up into **Tuples.cpp** and **Callables.cpp**.
60-
61-
## Level 5
62-
63-
**bridge-rt.ll** Defines the `@__quantum__rt__*` entry points (to be called by the `.ll` files generated from users' `.qs` files).
64-
The C++ Standard reserves the identifiers starting with double underscores `__`, that is why the definitions of `@__quantum__rt__*`
65-
have been put to `.ll` file rather than `.cpp` file.
66-
Depends on `quantum__rt__*` implementations (in **utils.cpp**, **strings.cpp**, **delegated.cpp**, **arrays.cpp**, **callables.cpp**).

src/Qir/Runtime/lib/QSharpCore/README.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,9 @@ Same-level entities are independent of each other (unless specified otherwise).
1818

1919
## Level 1
2020

21-
**qsharp__core__qis.hpp** Declares `quantum__qis__*()` gate set implementations.
21+
**qsharp__core__qis.hpp** Declares `__quantum__qis__*()` gate set implementations.
2222
Depends on `public\CoreTypes.hpp` (QUBIT, PauliId, RESULT)
2323
Uses `QirArray *` from `public\QirTypes.hpp`.
2424

25-
**intrinsics.cpp** Defines `quantum__qis__*()` gate set implementation.
25+
**intrinsics.cpp** Defines `__quantum__qis__*()` gate set implementation.
2626
Each API depends on `GlobalContext()`, `IQuantumGateSet`.
27-
28-
## Level 2
29-
30-
**qsharp-core-qis.ll** Defines `@__quantum__qis__*()` quantum gate set entry points (to be called by the `.ll` files generated from users' `.qs` files).
31-
The C++ Standard reserves the identifiers starting with double underscores `__`, that is why the definitions of `@__quantum__qis__*`
32-
have been put to `.ll` file rather than `.cpp` file.
33-
Depends on `quantum__qis__*` implementations (in **intrinsics.cpp**).

src/Qir/Runtime/lib/QSharpFoundation/README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,21 @@ Same-level entities are independent of each other (unless specified otherwise).
1717
**public\QirTypes.hpp** Defines `QirArray`, `QirString`, `PTuple`, `QirTupleHeader`, `TupleWithControls`, `QirCallable`, `QirRange`.
1818
Depends on the listed earlier ones.
1919

20-
**public\QirRuntime.hpp** Declares `quantum__rt__*()`. Depends on the listed earlier ones.
20+
**public\QirRuntime.hpp** Declares `__quantum__rt__*()`. Depends on the listed earlier ones.
2121

2222

2323
## Level 1
2424

25-
**conditionals.cpp** Defines `quantum__qis__apply*__body()`.
25+
**conditionals.cpp** Defines `__quantum__qis__apply*__body()`.
2626
Depends on QIR's `quantum__rt__result_{equal,get_zero}()`, declared in **public\QirRuntime.hpp**.
2727

28-
**intrinsicsMath.cpp** Defines `quantum__qis__*` math funcs implementations,
28+
**intrinsicsMath.cpp** Defines `__quantum__qis__*` math funcs implementations,
2929
`Quantum::Qis::Internal::{excStrDrawRandomVal,RandomizeSeed,GetLastGeneratedRandomI64,GetLastGeneratedRandomDouble}`.
3030
Depends on `quantum__rt__fail()`, `quantum__rt__string_create()`, declared in **public\QirRuntime.hpp**.
3131

3232

3333
## Level 2
3434

3535
**qsharp__foundation__qis.hpp**
36-
Declares `quantum__qis__*()` math funcs and ApplyIf.
36+
Declares `__quantum__qis__*()` math funcs and ApplyIf.
3737
Depends on **public\CoreTypes.hpp**, **public\QirTypes.hpp**.
38-
39-
**qsharp-foundation-qis.ll**
40-
Defines `@__quantum__qis__*()` math funcs and ApplyIf - entry points (to be called by the `.ll` files generated from users' `.qs` files).
41-
Depends on `quantum__qis__*` implementations (in **intrinsicsMath.cpp**, **conditionals.cpp**, ).

0 commit comments

Comments
 (0)