aboutsummaryrefslogtreecommitdiffstats
path: root/ArrayUtils.h
diff options
context:
space:
mode:
Diffstat (limited to 'ArrayUtils.h')
-rw-r--r--ArrayUtils.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/ArrayUtils.h b/ArrayUtils.h
index 31cca817..c7b05b6d 100644
--- a/ArrayUtils.h
+++ b/ArrayUtils.h
@@ -41,19 +41,19 @@ public:
/// Copies an array to an array in storage. The arrays can be of different types only if
/// their storage representation is the same.
- /// Stack pre: [source_reference] target_reference
- /// Stack post: target_reference
+ /// Stack pre: source_reference [source_byte_offset/source_length] target_reference target_byte_offset
+ /// Stack post: target_reference target_byte_offset
void copyArrayToStorage(ArrayType const& _targetType, ArrayType const& _sourceType) const;
/// Clears the given dynamic or static array.
- /// Stack pre: reference
+ /// Stack pre: storage_ref storage_byte_offset
/// Stack post:
void clearArray(ArrayType const& _type) const;
/// Clears the length and data elements of the array referenced on the stack.
- /// Stack pre: reference
+ /// Stack pre: reference (excludes byte offset)
/// Stack post:
void clearDynamicArray(ArrayType const& _type) const;
/// Changes the size of a dynamic array and clears the tail if it is shortened.
- /// Stack pre: reference new_length
+ /// Stack pre: reference (excludes byte offset) new_length
/// Stack post:
void resizeDynamicArray(ArrayType const& _type) const;
/// Appends a loop that clears a sequence of storage slots of the given type (excluding end).
@@ -67,7 +67,7 @@ public:
void convertLengthToSize(ArrayType const& _arrayType, bool _pad = false) const;
/// Retrieves the length (number of elements) of the array ref on the stack. This also
/// works for statically-sized arrays.
- /// Stack pre: reference
+ /// Stack pre: reference (excludes byte offset for dynamic storage arrays)
/// Stack post: reference length
void retrieveLength(ArrayType const& _arrayType) const;