Merge pull request #579 from PowerGridModel/feature/use-nan-in-struct

Use NaN as default value in input/output/update struct

Author: TonyXiang8787

code_generation/code_gen.py

@@ -16,6 +16,17 @@
 JINJA_ENV = Environment(loader=FileSystemLoader(TEMPLATE_DIR))
 
 
+def _data_type_nan(data_type: str):
+    if data_type == "ID":
+        return "na_IntID"
+    elif data_type == "double" or "RealValue" in data_type:
+        return "nan"
+    elif data_type == "IntS":
+        return "na_IntS"
+    else:
+        return f"static_cast<{data_type}>(na_IntS)"
+
+
 class CodeGenerator:
     all_classes: Dict[str, AttributeClass]
     base_output_path: Path
@@ -54,6 +65,7 @@ def render_attribute_classes(self, template_path: Path, data_path: Path, output_
                 attribute_class.specification_names = [attribute_class.name]
             new_attribute_list = []
             for attribute in attribute_class.attributes:
+                attribute.nan_value = _data_type_nan(attribute.data_type)
                 if isinstance(attribute.names, str):
                     new_attribute_list.append(attribute)
                 else:

code_generation/meta_data.py

@@ -5,7 +5,7 @@
 # define dataclass for meta data
 
 from dataclasses import dataclass
-from typing import List, Optional, Union
+from typing import Dict, List, Optional, Union
 
 from dataclasses_json import DataClassJsonMixin
 
@@ -15,6 +15,7 @@ class Attribute(DataClassJsonMixin):
     data_type: str
     names: Union[str, List[str]]
     description: str
+    nan_value: Optional[str] = None
 
 
 @dataclass
@@ -25,6 +26,8 @@ class AttributeClass(DataClassJsonMixin):
     base: Optional[str] = None
     is_template: bool = False
     full_name: Optional[str] = None
+    specification_names: Optional[List[str]] = None
+    base_attributes: Optional[Dict[str, List[Attribute]]] = None
 
 
 @dataclass

code_generation/templates/power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/attribute_classes.hpp.jinja

@@ -26,7 +26,7 @@ struct {{ attribute_class.name }} {
 {%- endif -%}
 
 {%- for attribute in attribute_class.full_attributes %}
-    {{ attribute.data_type }} {{ attribute.names }};
+    {{ attribute.data_type }} {{ attribute.names }}{ {{- attribute.nan_value -}} };
     {%- if attribute.description %}  // {{ attribute.description }}{%- endif %}
 {%- endfor %}
 {% for base_class in attribute_class.base_attributes %}

code_generation/templates/power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/meta_gen/attribute_classes.hpp.jinja

@@ -41,29 +41,6 @@ struct get_attributes_list<{{ attribute_class.name }}> {
 
 {% endfor %}
 
-// template specialization functors to get nan
-
-{% for attribute_class in classes -%}
-
-{%- if attribute_class.is_template -%}
-template <symmetry_tag sym_type>
-struct get_component_nan<{{ attribute_class.name }}<sym_type>> {
-    using sym = sym_type;
-{% else -%}
-template<>
-struct get_component_nan<{{ attribute_class.name }}> {
-{%- endif %}
-    {{ attribute_class.full_name }} operator() () const {
-        {{ attribute_class.full_name }} comp;
-        // all attributes including base class
-        {% for attribute in attribute_class.full_attributes %}
-        set_nan(comp.{{ attribute.names }});
-        {%- endfor %}
-        return comp;
-    }
-};
-
-{% endfor %}
 
 } // namespace power_grid_model::meta_data
 

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/input.hpp

@@ -27,10 +27,6 @@ template <class StructType, class ValueType> struct trait_pointer_to_member<Valu
 //    which is a std::array
 // the specializations are automatically generated
 template <class T> struct get_attributes_list;
-// primary template functor classes to generate nan value for a component
-// the specializations will contain operator() to return a component instance with NaNs
-// the specializations are automatically generated
-template <class T> struct get_component_nan;
 
 // ctype string
 template <class T> struct ctype_t;

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/meta_data.hpp

@@ -61,9 +61,8 @@ template <class StructType, auto component_name_getter> struct get_meta_componen
         .attributes = get_attributes_list<StructType>::value,
         .set_nan =
             [](RawDataPtr buffer_ptr, Idx pos, Idx size) {
-                static StructType const nan_value = get_component_nan<StructType>{}();
                 auto ptr = reinterpret_cast<StructType*>(buffer_ptr);
-                std::fill(ptr + pos, ptr + pos + size, nan_value);
+                std::fill(ptr + pos, ptr + pos + size, StructType{});
             },
         .create_buffer = [](Idx size) -> RawDataPtr { return new StructType[size]; },
         .destroy_buffer = [](RawDataConstPtr buffer_ptr) { delete[] reinterpret_cast<StructType const*>(buffer_ptr); },