classref: Sync with current master branch (46a568e0a)

classes/class_packedfloat32array.rst

@@ -15,7 +15,7 @@ A packed array of 32-bit floating-point values.
 Description
 -----------
 
-An array specifically designed to hold 32-bit floating-point values. Packs data tightly, so it saves memory for large array sizes.
+An array specifically designed to hold 32-bit floating-point values (float). Packs data tightly, so it saves memory for large array sizes.
 
 If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
 
@@ -40,6 +40,8 @@ Methods
 +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`int<class_int>`                               | :ref:`bsearch<class_PackedFloat32Array_method_bsearch>` **(** :ref:`float<class_float>` value, :ref:`bool<class_bool>` before=true **)**  |
 +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| void                                                | :ref:`clear<class_PackedFloat32Array_method_clear>` **(** **)**                                                                           |
++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`int<class_int>`                               | :ref:`count<class_PackedFloat32Array_method_count>` **(** :ref:`float<class_float>` value **)** |const|                                   |
 +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`duplicate<class_PackedFloat32Array_method_duplicate>` **(** **)**                                                                   |
@@ -138,6 +140,14 @@ Finds the index of an existing value (or the insertion index that maintains sort
 
 ----
 
+.. _class_PackedFloat32Array_method_clear:
+
+- void **clear** **(** **)**
+
+Clears the array. This is equivalent to using :ref:`resize<class_PackedFloat32Array_method_resize>` with a size of ``0``.
+
+----
+
 .. _class_PackedFloat32Array_method_count:
 
 - :ref:`int<class_int>` **count** **(** :ref:`float<class_float>` value **)** |const|
@@ -285,24 +295,34 @@ Operator Descriptions
 
 - :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` right **)**
 
+Returns ``true`` if contents of the arrays differ.
+
 ----
 
 .. _class_PackedFloat32Array_operator_sum_PackedFloat32Array:
 
 - :ref:`PackedFloat32Array<class_PackedFloat32Array>` **operator +** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` right **)**
 
+Returns a new ``PackedFloat32Array`` with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array<class_PackedFloat32Array_method_append_array>` instead.
+
 ----
 
 .. _class_PackedFloat32Array_operator_eq_bool:
 
 - :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` right **)**
 
+Returns ``true`` if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices.
+
 ----
 
 .. _class_PackedFloat32Array_operator_idx_float:
 
 - :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)**
 
+Returns the :ref:`float<class_float>` at index ``index``. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.
+
+Note that :ref:`float<class_float>` type is 64-bit, unlike the values stored in the array.
+
 .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
 .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
 .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`