Document that PoolRealArray stores 32-bit floats

This closes #45230.
This commit is contained in:
Hugo Locurcio 2021-01-16 14:14:51 +01:00
parent 51bcc875ea
commit e2c13c00f7
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C

View file

@ -4,8 +4,9 @@
A pooled [Array] of reals ([float]). A pooled [Array] of reals ([float]).
</brief_description> </brief_description>
<description> <description>
An [Array] specifically designed to hold floating-point values ([float]). Optimized for memory usage, does not fragment the memory. An [Array] specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference. [b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>