Merge branch 'main' of https://github.com/SoftStoneDevelop/StackMemoryCollections

Author: Vyacheslav

Documentation/Stack/Capacity.md

@@ -1 +1,8 @@
+# Capacity Property
 
+## Definition
+Gets the capacity of the collection
+
+```C#
+public nuint Capacity { get; private set; }
+```

Documentation/Stack/Clear.md

@@ -1,31 +1,8 @@
-# FreeMemory(nuint) Method
+# Clear() Method
 
 ## Definition
-Free memory.
+Remove all items from a collection
 
 ```C#
-public void FreeMemory(nuint reducingBytes)
+public void Clear()
 ```
-
-## Parameters
-reducingBytes nuint
-
-Freed memory size in bytes
-
-## Returns
-void
-
-## Exceptions
-
-```C#
-ObjectDisposedException
-```
--or-
-
-```C#
-Exception
-```
-If all memory is already free
-
-## Remark
-Shifts the Current pointer by -reducingBytes

Documentation/Stack/Constructor1.md

@@ -1,15 +1,11 @@
-# StackMemory(nuint) Constructor
+# StackOf{ItemType}() Constructor
 
 ## Definition
-Creates an instance and allocates memory
+Creates an instance with a capacity of 4 and on its own memory.
 
 ```C#
-public StackMemory(nuint byteCount)
+public StackOf{ItemType}()
 ```
-## Parametrs
-byteCount nuint
-
-Size of allocated memory in bytes
 
 ## Remarks
-The default constructor of a struct will throw an Exception
+The collection works like a regular collection with auto resizing.

Documentation/Stack/Constructor2.md

@@ -1,15 +1,21 @@
-# StackMemory(nuint) Constructor
+# StackOf{ItemType}(nuint, Struct.StackMemory*) Constructor
 
 ## Definition
-Creates an instance and allocates memory
+Creates an instance with Capacity equal `count` and allocate collection memory from StackMemory.
 
 ```C#
-public StackMemory(nuint byteCount)
+public StackOf{ItemType}(nuint count, Struct.StackMemory* stackMemory)
 ```
 ## Parametrs
-byteCount nuint
+`count nuint`
 
-Size of allocated memory in bytes
+Capacity of Collection
 
-## Remarks
-The default constructor of a struct will throw an Exception
+
+`Struct.StackMemory* stackMemory`
+
+The memory on which the collection runs
+
+## Exceptions
+`ArgumentNullException`
+if stackMemory is null

Documentation/Stack/Constructor3.md

@@ -1,15 +1,21 @@
-# StackMemory(nuint) Constructor
+# StackOf{ItemType}(nuint, Class.StackMemory) Constructor
 
 ## Definition
-Creates an instance and allocates memory
+Creates an instance with Capacity equal `count` and allocate collection memory from StackMemory.
 
 ```C#
-public StackMemory(nuint byteCount)
+public StackOf{ItemType}(nuint count, Class.StackMemory stackMemory)
 ```
 ## Parametrs
-byteCount nuint
+`count nuint`
 
-Size of allocated memory in bytes
+Capacity of Collection
 
-## Remarks
-The default constructor of a struct will throw an Exception
+
+`Class.StackMemory stackMemory`
+
+The memory on which the collection runs
+
+## Exceptions
+`ArgumentNullException`
+if stackMemory is null

Documentation/Stack/Constructor4.md

@@ -1 +1,26 @@
+# StackOf{ItemType}(nuint, void*) Constructor
 
+## Definition
+Creates an instance with a capacity of `count`, with memory for the collection starting at memoryStart.
+
+```C#
+public StackOf{ItemType}(nuint count, void* memoryStart)
+```
+## Parametrs
+`count nuint`
+
+Capacity of Collection
+
+
+`void* memoryStart`
+
+The memory on which the collection runs
+
+## Exceptions
+`ArgumentNullException`
+if memoryStart is null
+
+## Remarks
+
+The correctness of the memory remains under the control of the developer. The collection has no way to check the correctness of the passed pointer.
+For collections on primitive types memoryStart is `{ItemType}*` pointer

Documentation/Stack/Copy.md

@@ -1,31 +1,13 @@
-# FreeMemory(nuint) Method
+# Copy(in void*) Method
 
 ## Definition
-Free memory.
+Copies the elements of the collection into memory.
 
 ```C#
-public void FreeMemory(nuint reducingBytes)
+public void Copy(in void* ptrDest)
 ```
 
 ## Parameters
-reducingBytes nuint
+`in void* ptrDest`
 
-Freed memory size in bytes
-
-## Returns
-void
-
-## Exceptions
-
-```C#
-ObjectDisposedException
-```
--or-
-
-```C#
-Exception
-```
-If all memory is already free
-
-## Remark
-Shifts the Current pointer by -reducingBytes
+Pointer to the memory where the elements will be copied

Documentation/Stack/ExpandCapacity.md

@@ -8,7 +8,7 @@ public void ExpandCapacity(in nuint expandCount)
 ```
 
 ## Parameters
-expandCount nuint
+`expandCount nuint`
 
 Allocate memory size in count of items
 
@@ -21,3 +21,4 @@ If The Stack collection is created using StackMemory and the StackMemory has mov
 
 ## Remark
 Increases Capacity by quantity 'expandCount'
+If the instance was created using a [constructor on a pointer](https://github.com/SoftStoneDevelop/StackMemoryCollections/blob/main/Documentation/Stack/Constructor4.md) then: Copies elements to new memory (`Capacity + expandCount`), freeing the current memory.

Documentation/Stack/IsEmpty.md

@@ -1 +1,8 @@
+# IsEmpty Property
 
+## Definition
+Gets a sign of absence in the collection of elements
+
+```C#
+public bool IsEmpty => Size == 0;
+```

Documentation/Stack/Pop.md

@@ -1,31 +1,16 @@
-# FreeMemory(nuint) Method
+# Pop() Method
 
 ## Definition
-Free memory.
+Removes an element from the top of the stack
 
 ```C#
-public void FreeMemory(nuint reducingBytes)
+public void Pop()
 ```
 
-## Parameters
-reducingBytes nuint
-
-Freed memory size in bytes
-
-## Returns
-void
-
 ## Exceptions
 
-```C#
-ObjectDisposedException
-```
--or-
-
 ```C#
 Exception
 ```
-If all memory is already free
 
-## Remark
-Shifts the Current pointer by -reducingBytes
+If there are no elements on the stack