class_packedfloat64array.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedFloat64Array.xml.
  6. .. _class_PackedFloat64Array:
  7. PackedFloat64Array
  8. ==================
  9. A packed array of 64-bit floating-point values.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. An array specifically designed to hold 64-bit floating-point values (double). Packs data tightly, so it saves memory for large array sizes.
  14. If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array<class_PackedFloat32Array>` for a more memory-friendly alternative.
  15. \ **Differences between packed arrays, typed arrays, and untyped arrays:** Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. **PackedFloat64Array** versus ``Array[float]``). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as :ref:`Array.map()<class_Array_method_map>`. Typed arrays are in turn faster to iterate on and modify than untyped arrays.
  16. \ **Note:** Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use :ref:`duplicate()<class_PackedFloat64Array_method_duplicate>`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.
  17. .. note::
  18. There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
  19. .. rst-class:: classref-reftable-group
  20. Constructors
  21. ------------
  22. .. table::
  23. :widths: auto
  24. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>`\ (\ ) |
  26. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>`\ (\ from\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) |
  28. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>`\ (\ from\: :ref:`Array<class_Array>`\ ) |
  30. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. .. rst-class:: classref-reftable-group
  32. Methods
  33. -------
  34. .. table::
  35. :widths: auto
  36. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`bool<class_bool>` | :ref:`append<class_PackedFloat64Array_method_append>`\ (\ value\: :ref:`float<class_float>`\ ) |
  38. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  39. | |void| | :ref:`append_array<class_PackedFloat64Array_method_append_array>`\ (\ array\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) |
  40. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`bsearch<class_PackedFloat64Array_method_bsearch>`\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ ) |
  42. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`clear<class_PackedFloat64Array_method_clear>`\ (\ ) |
  44. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`int<class_int>` | :ref:`count<class_PackedFloat64Array_method_count>`\ (\ value\: :ref:`float<class_float>`\ ) |const| |
  46. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`duplicate<class_PackedFloat64Array_method_duplicate>`\ (\ ) |
  48. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`bool<class_bool>` | :ref:`erase<class_PackedFloat64Array_method_erase>`\ (\ value\: :ref:`float<class_float>`\ ) |
  50. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`fill<class_PackedFloat64Array_method_fill>`\ (\ value\: :ref:`float<class_float>`\ ) |
  52. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`int<class_int>` | :ref:`find<class_PackedFloat64Array_method_find>`\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const| |
  54. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`float<class_float>` | :ref:`get<class_PackedFloat64Array_method_get>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  56. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`bool<class_bool>` | :ref:`has<class_PackedFloat64Array_method_has>`\ (\ value\: :ref:`float<class_float>`\ ) |const| |
  58. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`int<class_int>` | :ref:`insert<class_PackedFloat64Array_method_insert>`\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) |
  60. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedFloat64Array_method_is_empty>`\ (\ ) |const| |
  62. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`bool<class_bool>` | :ref:`push_back<class_PackedFloat64Array_method_push_back>`\ (\ value\: :ref:`float<class_float>`\ ) |
  64. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`remove_at<class_PackedFloat64Array_method_remove_at>`\ (\ index\: :ref:`int<class_int>`\ ) |
  66. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`resize<class_PackedFloat64Array_method_resize>`\ (\ new_size\: :ref:`int<class_int>`\ ) |
  68. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`reverse<class_PackedFloat64Array_method_reverse>`\ (\ ) |
  70. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`int<class_int>` | :ref:`rfind<class_PackedFloat64Array_method_rfind>`\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const| |
  72. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`set<class_PackedFloat64Array_method_set>`\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) |
  74. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`int<class_int>` | :ref:`size<class_PackedFloat64Array_method_size>`\ (\ ) |const| |
  76. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`slice<class_PackedFloat64Array_method_slice>`\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| |
  78. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`sort<class_PackedFloat64Array_method_sort>`\ (\ ) |
  80. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedFloat64Array_method_to_byte_array>`\ (\ ) |const| |
  82. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  83. .. rst-class:: classref-reftable-group
  84. Operators
  85. ---------
  86. .. table::
  87. :widths: auto
  88. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedFloat64Array_operator_neq_PackedFloat64Array>`\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) |
  90. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`operator +<class_PackedFloat64Array_operator_sum_PackedFloat64Array>`\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) |
  92. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedFloat64Array_operator_eq_PackedFloat64Array>`\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) |
  94. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`float<class_float>` | :ref:`operator []<class_PackedFloat64Array_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  96. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  97. .. rst-class:: classref-section-separator
  98. ----
  99. .. rst-class:: classref-descriptions-group
  100. Constructor Descriptions
  101. ------------------------
  102. .. _class_PackedFloat64Array_constructor_PackedFloat64Array:
  103. .. rst-class:: classref-constructor
  104. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array**\ (\ ) :ref:`🔗<class_PackedFloat64Array_constructor_PackedFloat64Array>`
  105. Constructs an empty **PackedFloat64Array**.
  106. .. rst-class:: classref-item-separator
  107. ----
  108. .. rst-class:: classref-constructor
  109. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array**\ (\ from\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ )
  110. Constructs a **PackedFloat64Array** as a copy of the given **PackedFloat64Array**.
  111. .. rst-class:: classref-item-separator
  112. ----
  113. .. rst-class:: classref-constructor
  114. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array**\ (\ from\: :ref:`Array<class_Array>`\ )
  115. Constructs a new **PackedFloat64Array**. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
  116. .. rst-class:: classref-section-separator
  117. ----
  118. .. rst-class:: classref-descriptions-group
  119. Method Descriptions
  120. -------------------
  121. .. _class_PackedFloat64Array_method_append:
  122. .. rst-class:: classref-method
  123. :ref:`bool<class_bool>` **append**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_append>`
  124. Appends an element at the end of the array (alias of :ref:`push_back()<class_PackedFloat64Array_method_push_back>`).
  125. .. rst-class:: classref-item-separator
  126. ----
  127. .. _class_PackedFloat64Array_method_append_array:
  128. .. rst-class:: classref-method
  129. |void| **append_array**\ (\ array\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) :ref:`🔗<class_PackedFloat64Array_method_append_array>`
  130. Appends a **PackedFloat64Array** at the end of this array.
  131. .. rst-class:: classref-item-separator
  132. ----
  133. .. _class_PackedFloat64Array_method_bsearch:
  134. .. rst-class:: classref-method
  135. :ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_PackedFloat64Array_method_bsearch>`
  136. Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a ``before`` specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array.
  137. \ **Note:** Calling :ref:`bsearch()<class_PackedFloat64Array_method_bsearch>` on an unsorted array results in unexpected behavior.
  138. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  139. .. rst-class:: classref-item-separator
  140. ----
  141. .. _class_PackedFloat64Array_method_clear:
  142. .. rst-class:: classref-method
  143. |void| **clear**\ (\ ) :ref:`🔗<class_PackedFloat64Array_method_clear>`
  144. Clears the array. This is equivalent to using :ref:`resize()<class_PackedFloat64Array_method_resize>` with a size of ``0``.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_PackedFloat64Array_method_count:
  148. .. rst-class:: classref-method
  149. :ref:`int<class_int>` **count**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_count>`
  150. Returns the number of times an element is in the array.
  151. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  152. .. rst-class:: classref-item-separator
  153. ----
  154. .. _class_PackedFloat64Array_method_duplicate:
  155. .. rst-class:: classref-method
  156. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **duplicate**\ (\ ) :ref:`🔗<class_PackedFloat64Array_method_duplicate>`
  157. Creates a copy of the array, and returns it.
  158. .. rst-class:: classref-item-separator
  159. ----
  160. .. _class_PackedFloat64Array_method_erase:
  161. .. rst-class:: classref-method
  162. :ref:`bool<class_bool>` **erase**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_erase>`
  163. Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()<class_PackedFloat64Array_method_remove_at>` instead.
  164. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  165. .. rst-class:: classref-item-separator
  166. ----
  167. .. _class_PackedFloat64Array_method_fill:
  168. .. rst-class:: classref-method
  169. |void| **fill**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_fill>`
  170. Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize()<class_PackedFloat64Array_method_resize>` to create an array with a given size and initialized elements.
  171. .. rst-class:: classref-item-separator
  172. ----
  173. .. _class_PackedFloat64Array_method_find:
  174. .. rst-class:: classref-method
  175. :ref:`int<class_int>` **find**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_find>`
  176. Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed.
  177. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  178. .. rst-class:: classref-item-separator
  179. ----
  180. .. _class_PackedFloat64Array_method_get:
  181. .. rst-class:: classref-method
  182. :ref:`float<class_float>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_get>`
  183. Returns the 64-bit float at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0.0``.
  184. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
  185. .. rst-class:: classref-item-separator
  186. ----
  187. .. _class_PackedFloat64Array_method_has:
  188. .. rst-class:: classref-method
  189. :ref:`bool<class_bool>` **has**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_has>`
  190. Returns ``true`` if the array contains ``value``.
  191. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  192. .. rst-class:: classref-item-separator
  193. ----
  194. .. _class_PackedFloat64Array_method_insert:
  195. .. rst-class:: classref-method
  196. :ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_insert>`
  197. Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``).
  198. .. rst-class:: classref-item-separator
  199. ----
  200. .. _class_PackedFloat64Array_method_is_empty:
  201. .. rst-class:: classref-method
  202. :ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_is_empty>`
  203. Returns ``true`` if the array is empty.
  204. .. rst-class:: classref-item-separator
  205. ----
  206. .. _class_PackedFloat64Array_method_push_back:
  207. .. rst-class:: classref-method
  208. :ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_push_back>`
  209. Appends an element at the end of the array.
  210. .. rst-class:: classref-item-separator
  211. ----
  212. .. _class_PackedFloat64Array_method_remove_at:
  213. .. rst-class:: classref-method
  214. |void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat64Array_method_remove_at>`
  215. Removes an element from the array by index.
  216. .. rst-class:: classref-item-separator
  217. ----
  218. .. _class_PackedFloat64Array_method_resize:
  219. .. rst-class:: classref-method
  220. :ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat64Array_method_resize>`
  221. Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling :ref:`resize()<class_PackedFloat64Array_method_resize>` once and assigning the new values is faster than adding new elements one by one.
  222. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the following :ref:`Error<enum_@GlobalScope_Error>` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY<class_@GlobalScope_constant_ERR_OUT_OF_MEMORY>` if allocations fail. Use :ref:`size()<class_PackedFloat64Array_method_size>` to find the actual size of the array after resize.
  223. .. rst-class:: classref-item-separator
  224. ----
  225. .. _class_PackedFloat64Array_method_reverse:
  226. .. rst-class:: classref-method
  227. |void| **reverse**\ (\ ) :ref:`🔗<class_PackedFloat64Array_method_reverse>`
  228. Reverses the order of the elements in the array.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_PackedFloat64Array_method_rfind:
  232. .. rst-class:: classref-method
  233. :ref:`int<class_int>` **rfind**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_rfind>`
  234. Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
  235. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  236. .. rst-class:: classref-item-separator
  237. ----
  238. .. _class_PackedFloat64Array_method_set:
  239. .. rst-class:: classref-method
  240. |void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat64Array_method_set>`
  241. Changes the float at the given index.
  242. .. rst-class:: classref-item-separator
  243. ----
  244. .. _class_PackedFloat64Array_method_size:
  245. .. rst-class:: classref-method
  246. :ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_size>`
  247. Returns the number of elements in the array.
  248. .. rst-class:: classref-item-separator
  249. ----
  250. .. _class_PackedFloat64Array_method_slice:
  251. .. rst-class:: classref-method
  252. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_slice>`
  253. Returns the slice of the **PackedFloat64Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat64Array**.
  254. The absolute value of ``begin`` and ``end`` will be clamped to the array size, so the default value for ``end`` makes it slice to the size of the array by default (i.e. ``arr.slice(1)`` is a shorthand for ``arr.slice(1, arr.size())``).
  255. If either ``begin`` or ``end`` are negative, they will be relative to the end of the array (i.e. ``arr.slice(0, -2)`` is a shorthand for ``arr.slice(0, arr.size() - 2)``).
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_PackedFloat64Array_method_sort:
  259. .. rst-class:: classref-method
  260. |void| **sort**\ (\ ) :ref:`🔗<class_PackedFloat64Array_method_sort>`
  261. Sorts the elements of the array in ascending order.
  262. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  263. .. rst-class:: classref-item-separator
  264. ----
  265. .. _class_PackedFloat64Array_method_to_byte_array:
  266. .. rst-class:: classref-method
  267. :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedFloat64Array_method_to_byte_array>`
  268. Returns a copy of the data converted to a :ref:`PackedByteArray<class_PackedByteArray>`, where each element has been encoded as 8 bytes.
  269. The size of the new array will be ``float64_array.size() * 8``.
  270. .. rst-class:: classref-section-separator
  271. ----
  272. .. rst-class:: classref-descriptions-group
  273. Operator Descriptions
  274. ---------------------
  275. .. _class_PackedFloat64Array_operator_neq_PackedFloat64Array:
  276. .. rst-class:: classref-operator
  277. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) :ref:`🔗<class_PackedFloat64Array_operator_neq_PackedFloat64Array>`
  278. Returns ``true`` if contents of the arrays differ.
  279. .. rst-class:: classref-item-separator
  280. ----
  281. .. _class_PackedFloat64Array_operator_sum_PackedFloat64Array:
  282. .. rst-class:: classref-operator
  283. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **operator +**\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) :ref:`🔗<class_PackedFloat64Array_operator_sum_PackedFloat64Array>`
  284. Returns a new **PackedFloat64Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array()<class_PackedFloat64Array_method_append_array>` instead.
  285. .. rst-class:: classref-item-separator
  286. ----
  287. .. _class_PackedFloat64Array_operator_eq_PackedFloat64Array:
  288. .. rst-class:: classref-operator
  289. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedFloat64Array<class_PackedFloat64Array>`\ ) :ref:`🔗<class_PackedFloat64Array_operator_eq_PackedFloat64Array>`
  290. Returns ``true`` if contents of both arrays are the same, i.e. they have all equal doubles at the corresponding indices.
  291. .. rst-class:: classref-item-separator
  292. ----
  293. .. _class_PackedFloat64Array_operator_idx_int:
  294. .. rst-class:: classref-operator
  295. :ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat64Array_operator_idx_int>`
  296. 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.
  297. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  298. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  299. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  300. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  301. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  302. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  303. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  304. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  305. .. |void| replace:: :abbr:`void (No return value.)`