power-grid-model 1.12.57__py3-none-win_amd64.whl → 1.12.59__py3-none-win_amd64.whl

power_grid_model/_core/power_grid_model_c/include/power_grid_model_c/handle.h

@@ -1,99 +1,99 @@
-// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-//
-// SPDX-License-Identifier: MPL-2.0
-
-/**
- * @brief header file which includes handle functions
- *
- */
-
-#pragma once
-#ifndef POWER_GRID_MODEL_C_HANDLE_H
-#define POWER_GRID_MODEL_C_HANDLE_H
-
-#include "basics.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @brief Create a new handle.
- *
- * A handle object is needed to store error information.
- * If you run it in multi-threading at user side, each thread should have unique handle.
- * The handle should be destroyed by PGM_destroy_handle().
- *
- * @return A pointer to the created handle.
- */
-PGM_API PGM_Handle* PGM_create_handle(void);
-
-/**
- * @brief Destroy the handle.
- *
- * @param handle The pointer to the handle created by PGM_create_handle().
- */
-PGM_API void PGM_destroy_handle(PGM_Handle* handle);
-
-/**
- * @brief Get error code of last operation.
- *
- * @param handle The pointer to the handle you just used for an operation.
- * @return The error code, see #PGM_ErrorCode .
- */
-PGM_API PGM_Idx PGM_error_code(PGM_Handle const* handle);
-
-/**
- * @brief Get error message of last operation.
- *
- * If the error code is PGM_batch_error.
- * Use PGM_n_failed_scenarios(), PGM_failed_scenarios(), and PGM_batch_errors() to retrieve the detail.
- *
- * @param handle The pointer to the handle you just used for an operation.
- * @return A char const* poiner to a zero terminated string.
- * The pointer is not valid if you execute another operation.
- * You need to copy the string in your own data.
- */
-PGM_API char const* PGM_error_message(PGM_Handle const* handle);
-
-/**
- * @brief Get the number of failed scenarios. Only applicable when you just executed a batch calculation.
- *
- * @param handle The pointer to the handle you just used for a batch calculation.
- * @return The number of failed scenarios.
- */
-PGM_API PGM_Idx PGM_n_failed_scenarios(PGM_Handle const* handle);
-
-/**
- * @brief Get the list of failed scenarios, Only applicable when you just execute a batch calculation.
- *
- * @param handle The pointer to the handle you just used for a batch calculation.
- * @return A pointer to a PGM_Idx array with length returned by PGM_n_failed_scenarios().
- * The pointer is not valid if you execute another operation.
- * You need to copy the array in your own data.
- */
-PGM_API PGM_Idx const* PGM_failed_scenarios(PGM_Handle const* handle);
-
-/**
- * @brief Get the list of batch errors. Only applicable when you just execute a batch calculation.
- *
- * @param handle The pointer to the handle you just used for a batch calculation.
- * @return A pointer to a char const* array with length returned by PGM_n_failed_scenarios().
- * Each entry is a zero terminated string.
- * The pointer is not valid if you execute another operation.
- * You need to copy the array (and the string) in your own data.
- */
-PGM_API char const** PGM_batch_errors(PGM_Handle const* handle);
-
-/**
- * @brief Clear and reset the handle.
- *
- * @param handle The pointer to the handle.
- */
-PGM_API void PGM_clear_error(PGM_Handle* handle);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
+// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+//
+// SPDX-License-Identifier: MPL-2.0
+
+/**
+ * @brief header file which includes handle functions
+ *
+ */
+
+#pragma once
+#ifndef POWER_GRID_MODEL_C_HANDLE_H
+#define POWER_GRID_MODEL_C_HANDLE_H
+
+#include "basics.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Create a new handle.
+ *
+ * A handle object is needed to store error information.
+ * If you run it in multi-threading at user side, each thread should have unique handle.
+ * The handle should be destroyed by PGM_destroy_handle().
+ *
+ * @return A pointer to the created handle.
+ */
+PGM_API PGM_Handle* PGM_create_handle(void);
+
+/**
+ * @brief Destroy the handle.
+ *
+ * @param handle The pointer to the handle created by PGM_create_handle().
+ */
+PGM_API void PGM_destroy_handle(PGM_Handle* handle);
+
+/**
+ * @brief Get error code of last operation.
+ *
+ * @param handle The pointer to the handle you just used for an operation.
+ * @return The error code, see #PGM_ErrorCode .
+ */
+PGM_API PGM_Idx PGM_error_code(PGM_Handle const* handle);
+
+/**
+ * @brief Get error message of last operation.
+ *
+ * If the error code is PGM_batch_error.
+ * Use PGM_n_failed_scenarios(), PGM_failed_scenarios(), and PGM_batch_errors() to retrieve the detail.
+ *
+ * @param handle The pointer to the handle you just used for an operation.
+ * @return A char const* poiner to a zero terminated string.
+ * The pointer is not valid if you execute another operation.
+ * You need to copy the string in your own data.
+ */
+PGM_API char const* PGM_error_message(PGM_Handle const* handle);
+
+/**
+ * @brief Get the number of failed scenarios. Only applicable when you just executed a batch calculation.
+ *
+ * @param handle The pointer to the handle you just used for a batch calculation.
+ * @return The number of failed scenarios.
+ */
+PGM_API PGM_Idx PGM_n_failed_scenarios(PGM_Handle const* handle);
+
+/**
+ * @brief Get the list of failed scenarios, Only applicable when you just execute a batch calculation.
+ *
+ * @param handle The pointer to the handle you just used for a batch calculation.
+ * @return A pointer to a PGM_Idx array with length returned by PGM_n_failed_scenarios().
+ * The pointer is not valid if you execute another operation.
+ * You need to copy the array in your own data.
+ */
+PGM_API PGM_Idx const* PGM_failed_scenarios(PGM_Handle const* handle);
+
+/**
+ * @brief Get the list of batch errors. Only applicable when you just execute a batch calculation.
+ *
+ * @param handle The pointer to the handle you just used for a batch calculation.
+ * @return A pointer to a char const* array with length returned by PGM_n_failed_scenarios().
+ * Each entry is a zero terminated string.
+ * The pointer is not valid if you execute another operation.
+ * You need to copy the array (and the string) in your own data.
+ */
+PGM_API char const** PGM_batch_errors(PGM_Handle const* handle);
+
+/**
+ * @brief Clear and reset the handle.
+ *
+ * @param handle The pointer to the handle.
+ */
+PGM_API void PGM_clear_error(PGM_Handle* handle);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

power_grid_model/_core/power_grid_model_c/include/power_grid_model_c/meta_data.h

@@ -1,189 +1,189 @@
-// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
-//
-// SPDX-License-Identifier: MPL-2.0
-
-/**
- * @brief header file which includes meta data functions
- *
- */
-
-#pragma once
-#ifndef POWER_GRID_MODEL_C_META_DATA_H
-#define POWER_GRID_MODEL_C_META_DATA_H
-
-#include "basics.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @brief Get number of datasets.
- *
- * @param handle
- * @return The number of datasets.
- */
-PGM_API PGM_Idx PGM_meta_n_datasets(PGM_Handle* handle);
-
-/**
- * @brief Get pointer of idx-th dataset.
- *
- * @param handle
- * @param idx The sequence number, should be between [0, PGM_meta_n_datasets()).
- * @return The pointer to the idx-th dataset. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaDataset const* PGM_meta_get_dataset_by_idx(PGM_Handle* handle, PGM_Idx idx);
-
-/**
- * @brief Get pointer of dataset by name.
- *
- * @param handle
- * @param dataset The name of the dataset.
- * @return The pointer to the dataset with that name. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaDataset const* PGM_meta_get_dataset_by_name(PGM_Handle* handle, char const* dataset);
-
-/**
- * @brief Get name of the dataset.
- *
- * @param handle
- * @param dataset The pointer to a dataset object.
- * @return The name of the dataset in a char const*. The pointer is permanantly valid.
- */
-PGM_API char const* PGM_meta_dataset_name(PGM_Handle* handle, PGM_MetaDataset const* dataset);
-
-/**
- * @brief Get the number of components for a dataset.
- *
- * @param handle
- * @param dataset The pointer to the dataset.
- * @return Number of components.
- */
-PGM_API PGM_Idx PGM_meta_n_components(PGM_Handle* handle, PGM_MetaDataset const* dataset);
-
-/**
- * @brief Get pointer of idx-th component of a dataset.
- *
- * @param handle
- * @param dataset The pointer to the dataset.
- * @param idx The sequence number, should be between [0, PGM_meta_n_components()).
- * @return The pointer to the idx-th component. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaComponent const* PGM_meta_get_component_by_idx(PGM_Handle* handle, PGM_MetaDataset const* dataset,
-                                                               PGM_Idx idx);
-/**
- * @brief Get pointer of a component by name.
- *
- * @param handle
- * @param dataset The name of the dataset.
- * @param component The name of the component.
- * @return The pointer to the component with that name. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaComponent const* PGM_meta_get_component_by_name(PGM_Handle* handle, char const* dataset,
-                                                                char const* component);
-
-/**
- * @brief Get name of component.
- *
- * @param handle
- * @param component The pointer to the component.
- * @return The name of the component in a char const*. The pointer is permanantly valid.
- */
-PGM_API char const* PGM_meta_component_name(PGM_Handle* handle, PGM_MetaComponent const* component);
-
-/**
- * @brief Get size of the component.
- *
- * @param handle
- * @param component The pointer to the component.
- * @return Size of the component.
- */
-PGM_API size_t PGM_meta_component_size(PGM_Handle* handle, PGM_MetaComponent const* component);
-
-/**
- * @brief Get alignment of the component.
- *
- * @param handle
- * @param component The pointer to the component.
- * @return Alignment of the component.
- */
-PGM_API size_t PGM_meta_component_alignment(PGM_Handle* handle, PGM_MetaComponent const* component);
-
-/**
- * @brief Get number of attributes of the component.
- *
- * @param handle
- * @param component The pointer to the component.
- * @return Number of attributes.
- */
-PGM_API PGM_Idx PGM_meta_n_attributes(PGM_Handle* handle, PGM_MetaComponent const* component);
-
-/**
- * @brief Get pointer of idx-th attribute of a component.
- *
- * @param handle
- * @param component The pointer to the component.
- * @param idx The sequence number, should be between [0, PGM_meta_n_attributes())
- * @return The pointer to the idx-th attribute. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaAttribute const* PGM_meta_get_attribute_by_idx(PGM_Handle* handle, PGM_MetaComponent const* component,
-                                                               PGM_Idx idx);
-/**
- * @brief Get pointer of a attribute by name.
- *
- * @param handle
- * @param dataset The name of the dataset.
- * @param component The name of the component.
- * @param attribute The name of the attribute.
- * @return The pointer to the component with that name. The pointer is permanantly valid.
- * Or a NULL if your input is out of bound.
- */
-PGM_API PGM_MetaAttribute const* PGM_meta_get_attribute_by_name(PGM_Handle* handle, char const* dataset,
-                                                                char const* component, char const* attribute);
-
-/**
- * @brief Get attribute name.
- *
- * @param handle
- * @param attribute The pointer to attribute.
- * @return The name of the attribute in char const*. The pointer is permanantly valid.
- */
-PGM_API char const* PGM_meta_attribute_name(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
-
-/**
- * @brief Get the type of an attribute.
- *
- * @param handle
- * @param attribute The pointer to attribute.
- * @return The type of the attribute as in enum PGM_CType.
- *
- */
-PGM_API PGM_Idx PGM_meta_attribute_ctype(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
-
-/**
- * @brief Get the offset of an attribute in a component.
- *
- * @param handle
- * @param attribute The pointer to attribute.
- * @return The offset of this attribute.
- */
-PGM_API size_t PGM_meta_attribute_offset(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
-
-/**
- * @brief Get whether the system is little endian.
- *
- * @param handle
- * @return 1 if the system is litten endian; 0 if the system is big endian.
- */
-PGM_API int PGM_is_little_endian(PGM_Handle* handle);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
+// SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+//
+// SPDX-License-Identifier: MPL-2.0
+
+/**
+ * @brief header file which includes meta data functions
+ *
+ */
+
+#pragma once
+#ifndef POWER_GRID_MODEL_C_META_DATA_H
+#define POWER_GRID_MODEL_C_META_DATA_H
+
+#include "basics.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Get number of datasets.
+ *
+ * @param handle
+ * @return The number of datasets.
+ */
+PGM_API PGM_Idx PGM_meta_n_datasets(PGM_Handle* handle);
+
+/**
+ * @brief Get pointer of idx-th dataset.
+ *
+ * @param handle
+ * @param idx The sequence number, should be between [0, PGM_meta_n_datasets()).
+ * @return The pointer to the idx-th dataset. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaDataset const* PGM_meta_get_dataset_by_idx(PGM_Handle* handle, PGM_Idx idx);
+
+/**
+ * @brief Get pointer of dataset by name.
+ *
+ * @param handle
+ * @param dataset The name of the dataset.
+ * @return The pointer to the dataset with that name. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaDataset const* PGM_meta_get_dataset_by_name(PGM_Handle* handle, char const* dataset);
+
+/**
+ * @brief Get name of the dataset.
+ *
+ * @param handle
+ * @param dataset The pointer to a dataset object.
+ * @return The name of the dataset in a char const*. The pointer is permanantly valid.
+ */
+PGM_API char const* PGM_meta_dataset_name(PGM_Handle* handle, PGM_MetaDataset const* dataset);
+
+/**
+ * @brief Get the number of components for a dataset.
+ *
+ * @param handle
+ * @param dataset The pointer to the dataset.
+ * @return Number of components.
+ */
+PGM_API PGM_Idx PGM_meta_n_components(PGM_Handle* handle, PGM_MetaDataset const* dataset);
+
+/**
+ * @brief Get pointer of idx-th component of a dataset.
+ *
+ * @param handle
+ * @param dataset The pointer to the dataset.
+ * @param idx The sequence number, should be between [0, PGM_meta_n_components()).
+ * @return The pointer to the idx-th component. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaComponent const* PGM_meta_get_component_by_idx(PGM_Handle* handle, PGM_MetaDataset const* dataset,
+                                                               PGM_Idx idx);
+/**
+ * @brief Get pointer of a component by name.
+ *
+ * @param handle
+ * @param dataset The name of the dataset.
+ * @param component The name of the component.
+ * @return The pointer to the component with that name. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaComponent const* PGM_meta_get_component_by_name(PGM_Handle* handle, char const* dataset,
+                                                                char const* component);
+
+/**
+ * @brief Get name of component.
+ *
+ * @param handle
+ * @param component The pointer to the component.
+ * @return The name of the component in a char const*. The pointer is permanantly valid.
+ */
+PGM_API char const* PGM_meta_component_name(PGM_Handle* handle, PGM_MetaComponent const* component);
+
+/**
+ * @brief Get size of the component.
+ *
+ * @param handle
+ * @param component The pointer to the component.
+ * @return Size of the component.
+ */
+PGM_API size_t PGM_meta_component_size(PGM_Handle* handle, PGM_MetaComponent const* component);
+
+/**
+ * @brief Get alignment of the component.
+ *
+ * @param handle
+ * @param component The pointer to the component.
+ * @return Alignment of the component.
+ */
+PGM_API size_t PGM_meta_component_alignment(PGM_Handle* handle, PGM_MetaComponent const* component);
+
+/**
+ * @brief Get number of attributes of the component.
+ *
+ * @param handle
+ * @param component The pointer to the component.
+ * @return Number of attributes.
+ */
+PGM_API PGM_Idx PGM_meta_n_attributes(PGM_Handle* handle, PGM_MetaComponent const* component);
+
+/**
+ * @brief Get pointer of idx-th attribute of a component.
+ *
+ * @param handle
+ * @param component The pointer to the component.
+ * @param idx The sequence number, should be between [0, PGM_meta_n_attributes())
+ * @return The pointer to the idx-th attribute. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaAttribute const* PGM_meta_get_attribute_by_idx(PGM_Handle* handle, PGM_MetaComponent const* component,
+                                                               PGM_Idx idx);
+/**
+ * @brief Get pointer of a attribute by name.
+ *
+ * @param handle
+ * @param dataset The name of the dataset.
+ * @param component The name of the component.
+ * @param attribute The name of the attribute.
+ * @return The pointer to the component with that name. The pointer is permanantly valid.
+ * Or a NULL if your input is out of bound.
+ */
+PGM_API PGM_MetaAttribute const* PGM_meta_get_attribute_by_name(PGM_Handle* handle, char const* dataset,
+                                                                char const* component, char const* attribute);
+
+/**
+ * @brief Get attribute name.
+ *
+ * @param handle
+ * @param attribute The pointer to attribute.
+ * @return The name of the attribute in char const*. The pointer is permanantly valid.
+ */
+PGM_API char const* PGM_meta_attribute_name(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
+
+/**
+ * @brief Get the type of an attribute.
+ *
+ * @param handle
+ * @param attribute The pointer to attribute.
+ * @return The type of the attribute as in enum PGM_CType.
+ *
+ */
+PGM_API PGM_Idx PGM_meta_attribute_ctype(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
+
+/**
+ * @brief Get the offset of an attribute in a component.
+ *
+ * @param handle
+ * @param attribute The pointer to attribute.
+ * @return The offset of this attribute.
+ */
+PGM_API size_t PGM_meta_attribute_offset(PGM_Handle* handle, PGM_MetaAttribute const* attribute);
+
+/**
+ * @brief Get whether the system is little endian.
+ *
+ * @param handle
+ * @return 1 if the system is litten endian; 0 if the system is big endian.
+ */
+PGM_API int PGM_is_little_endian(PGM_Handle* handle);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif