Documentation for microsoft::quantum::BasicAllocationManager::AllocatedMemoryBlock

microsoft::quantum::BasicAllocationManager::AllocatedMemoryBlock

More...

#include <AllocationManager/AllocationManager.hpp>

Public Attributes

Name
String name
Name of the segment, if any given.
Index count
Number of elements contained within memory address segment.
Address start
Start address of memory address segment.
Address end
End address (not included in memory address segment)

Detailed Description

struct microsoft::quantum::BasicAllocationManager::AllocatedMemoryBlock;

Defines a named register/memory address segment with start position, end position and count. We think of the address space as a continuous sequence of spaces that can store values and we refer to a bounded continuous sequence memory addresses as a segment (or memory address segment):

             start                   end
               │                      │
               ▼                      ▼
            ┌  ─  ─  ─  ─  ─  ─  ─
┌ ─ ─ ┬ ─ ─ ┬─────┬─────┐    ┌─────┼ ─ ─ ┬ ─ ─ ┐
   0     1  │  2  │  3  │... │ N+1 │ N+2   N+3
└ ─ ─ ┴ ─ ─ ┴─────┴─────┘    └─────┴ ─ ─ ┴ ─ ─ ┘
Address                            │
space       │    Memory address
                    segment
                 of N elements     │
            └  ─  ─  ─  ─  ─  ─  ─

Public Attributes Documentation

variable name

String name {""};

Name of the segment, if any given.

variable count

Index count {0};

Number of elements contained within memory address segment.

variable start

Address start {0};

Start address of memory address segment.

variable end

Address end {0};

End address (not included in memory address segment)

Updated on 1 August 2023 at 16:25:10 UTC