Ikarus/libikarus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

make values capable of being a list & add boost

Browse source 
Signed-off-by: Folling <mail@folling.io>
This commit is contained in:
Folling 2023-11-28 11:05:53 +01:00 • committed by Folling
parent b37ca963cd
commit 3697759ceb
No known key found for this signature in database
16 changed files with 315 additions and 140 deletions
Download patch file Download diff file Expand all files Collapse all files

49
include/ikarus/values/number_value.h
View file

@ -4,42 +4,57 @@
/// \author Folling <folling@ikarus.world>
#include <ikarus/macros.h>
#include <ikarus/stdtypes.h>
/// \addtogroup values Values
/// @{
IKARUS_BEGIN_HEADER
/// \brief A true/false boolean-like value. For example "IsDead".
/// \brief A true/false long doubleean-esque value. For example "Is Dead".
struct IkarusNumberValue;
/// \brief Creates a number value from a long double.
/// \param value The numeric value.
/// \return The entity value.
/// \brief Creates a number value from doubles.
/// \param data The number data or null if you wish to clear the data.
/// \details LibIkarus does not take ownership of this array.
/// \param data_size The size of the data array or 0 if you wish to clear the data.
/// \return The value.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusNumberValue * ikarus_number_value_create(long double value);
IKA_API IkarusNumberValue * ikarus_number_value_create(long double * data, size_t data_size);
/// \brief Creates an indeterminate number value.
/// \return The entity value.
/// \return The value.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusNumberValue * ikarus_number_value_create_indeterminate();
/// \brief Fetches the underlying value of a number value.
/// \param value The number value.
/// \return The underlying value.
/// \warning Undefined if the value is indeterminate.
IKA_API long double ikarus_number_value_get(IkarusNumberValue const * value);
/// \brief Sets the value of a number value.
/// \brief Fetches the underlying data of a number value.
/// \details You may adjust the returned data as per your hearts desire.
/// If you need to grow the data, use #ikarus_number_value_set with a new array.
/// Just remember that IkarusValues are plain objects, so changing them won't affect any state.
/// They will need to be submitted to other functions such as #ikarus_entity_set_value to have any effect.
/// \param value The number value.
/// \pre \li Must not be null.
/// \param new_value The new value.
IKA_API void ikarus_number_value_set(IkarusNumberValue * value, bool new_value);
/// \param data_size_out An out-parameter for the size of the returned array.
/// \remark Ignored if null.
/// \return The underlying data. Owned by LibIkarus, most not be freed.
/// \warning Undefined if the value is indeterminate.
IKA_API long double * ikarus_number_value_get(IkarusNumberValue * value, size_t * data_size_out);
/// \see ikarus_number_value_get
long double const * ikarus_number_value_get_const(IkarusNumberValue const * value, size_t * data_size_out);
/// \brief Sets the data of a number value.
/// \param value The number value.
/// \pre \li Must not be null.
/// \param new_data The new data or null if you wish to clear the data.
/// \details LibIkarus does not take ownership of this array.
/// \param new_data_size The size of the new data array or 0 if you wish to clear the data.
IKA_API void ikarus_number_value_set(IkarusNumberValue * value, long double * new_data, size_t new_data_size);
/// \brief Converts a number value to an entity value.
/// \param number_value The number value to convert.
/// \param value The number value to convert.
/// \return The converted entity value.
IKA_API struct IkarusValue * ikarus_number_value_to_value(IkarusNumberValue * number_value);
IKA_API struct IkarusValue * ikarus_number_value_to_value(IkarusNumberValue * value);
IKARUS_END_HEADER