---
name: "sc_ProcMemoryGrp"
section: "3"
platform: "linux"
package: "libsc-doc"
version: "2.3.1-22"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/sc_ProcMemoryGrp"
---

# sc\_ProcMemoryGrp(3)

The ProcMemoryGrp concrete class provides an implementation of MemoryGrp for a single processor.

## NAME

sc::ProcMemoryGrp - The **ProcMemoryGrp** concrete class provides an implementation of **MemoryGrp** for a single processor.

## SYNOPSIS

`#include <memproc.h>`

Inherits **sc::MemoryGrp**.

### Public Member Functions

**ProcMemoryGrp** (const **Ref**\< **KeyVal** \> &)\
 void **set\_localsize** (size\_t)\
 Set the size of locally held memory.  void \* **localdata** ()\
 Returns a pointer to the local data.  void \* **obtain\_readwrite** (**distsize\_t** **offset**, int **size**)\
 Only one thread can have an unreleased obtain\_readwrite at a time.  void \* **obtain\_readonly** (**distsize\_t** **offset**, int **size**)\
 This gives read access to the memory location. No locking is done.  void \* **obtain\_writeonly** (**distsize\_t** **offset**, int **size**)\
 This gives write access to the memory location. No locking is done.  void **release\_readonly** (void \*data, **distsize\_t** **offset**, int **size**)\
 This is called when read access is no longer needed.  void **release\_writeonly** (void \*data, **distsize\_t** **offset**, int **size**)\
 This is called when write access is no longer needed.  void **release\_readwrite** (void \*data, **distsize\_t** **offset**, int **size**)\
 This is called when read/write access is no longer needed.  void **sync** ()\
 Synchronizes all the nodes.

### Additional Inherited Members

## Detailed Description

The **ProcMemoryGrp** concrete class provides an implementation of **MemoryGrp** for a single processor.

## Member Function Documentation

### void \* sc::ProcMemoryGrp::localdata ()` [virtual]`

Returns a pointer to the local data.

Implements **sc::MemoryGrp**.

### void \* sc::ProcMemoryGrp::obtain\_readonly (distsize\_t offset, int size)` [virtual]`

This gives read access to the memory location. No locking is done.

Implements **sc::MemoryGrp**.

### void \* sc::ProcMemoryGrp::obtain\_readwrite (distsize\_t offset, int size)` [virtual]`

Only one thread can have an unreleased obtain\_readwrite at a time. The actual memory region locked can be larger than that requested. If the memory region is already locked this will block. For this reason, data should be held as read/write for as short a time as possible.

Implements **sc::MemoryGrp**.

### void \* sc::ProcMemoryGrp::obtain\_writeonly (distsize\_t offset, int size)` [virtual]`

This gives write access to the memory location. No locking is done.

Implements **sc::MemoryGrp**.

### void sc::ProcMemoryGrp::release\_readonly (void \* data, distsize\_t offset, int size)` [virtual]`

This is called when read access is no longer needed.

Implements **sc::MemoryGrp**.

### void sc::ProcMemoryGrp::release\_readwrite (void \* data, distsize\_t offset, int size)` [virtual]`

This is called when read/write access is no longer needed. The memory will be unlocked.

Implements **sc::MemoryGrp**.

### void sc::ProcMemoryGrp::release\_writeonly (void \* data, distsize\_t offset, int size)` [virtual]`

This is called when write access is no longer needed.

Implements **sc::MemoryGrp**.

### void sc::ProcMemoryGrp::set\_localsize (size\_t)` [virtual]`

Set the size of locally held memory. When memory is accessed using a global offset counting starts at node 0 and proceeds up to node **n()** - 1.

Implements **sc::MemoryGrp**.

### void sc::ProcMemoryGrp::sync ()` [virtual]`

Synchronizes all the nodes. This is useful after remote memory writes to be certain that all of the writes have completed and the data can be accessed locally, for example.

Implements **sc::MemoryGrp**.

## Author

Generated automatically by Doxygen for MPQC from the source code.