Add support for building targets with examples (LUE_WITH_EXAMPLES)

Author: kordejong

environment/cmake/Lue.cmake

@@ -106,6 +106,7 @@ message(STATUS "Build documentation           : ${LUE_BUILD_DOCUMENTATION}")
 message(STATUS "Build quality assurance       : ${LUE_BUILD_QUALITY_ASSURANCE}")
 message(STATUS "+ python api                  : ${LUE_QUALITY_ASSURANCE_WITH_PYTHON_API}")
 message(STATUS "+ tests                       : ${LUE_QUALITY_ASSURANCE_WITH_TESTS}")
+message(STATUS "With examples                 : ${LUE_WITH_EXAMPLES}")
 message(STATUS "")
 message(STATUS "CMAKE_GENERATOR               : ${CMAKE_GENERATOR}")
 message(STATUS "GENERATOR_IS_MULTI_CONFIG     : ${GENERATOR_IS_MULTI_CONFIG}")

environment/cmake/LueConfiguration.cmake

@@ -38,6 +38,10 @@ option(LUE_BUILD_DOCUMENTATION
     "Build documentation"
     FALSE)
 
+option(LUE_WITH_EXAMPLES
+    "Include examples"
+    FALSE)
+
 option(LUE_BUILD_QUALITY_ASSURANCE
     "Include support for quality assurance"
     FALSE)

source/framework/algorithm/CMakeLists.txt

@@ -1972,6 +1972,10 @@ lue_install_development_libraries(
 
 # ------------------------------------------------------------------------------
 
+if(LUE_WITH_EXAMPLES)
+    add_subdirectory(example)
+endif()
+
 if(LUE_BUILD_TESTS)
     add_subdirectory(test)
 endif()

source/framework/algorithm/example/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_executable(lue.framework.algorithm.example.ndvi ndvi.cpp)
+
+target_link_libraries(lue.framework.algorithm.example.ndvi
+    PRIVATE
+        lue::framework_local_operation
+        lue::framework_miscellaneous_operation
+)
+
+lue_install_executables(
+    TARGETS
+        lue.framework.algorithm.example.ndvi
+)

source/framework/algorithm/example/ndvi.cpp

@@ -0,0 +1,42 @@
+#include "lue/framework/algorithm/operator.hpp"
+#include "lue/framework/algorithm/value_policies/add.hpp"
+#include "lue/framework/algorithm/value_policies/divide.hpp"
+#include "lue/framework/algorithm/value_policies/subtract.hpp"
+#include "lue/framework/algorithm/value_policies/uniform.hpp"
+#include "lue/framework/core/component.hpp"
+#include <hpx/hpx_init.hpp>
+
+
+auto hpx_main([[maybe_unused]] int argc, [[maybe_unused]] char* argv[]) -> int
+{
+    using namespace lue::value_policies;
+
+    using Element = float;
+    lue::Rank const rank{2};
+    using Array = lue::PartitionedArray<Element, rank>;
+    using Shape = lue::ShapeT<Array>;
+
+    Shape const array_shape{40000, 40000};
+    Shape const partition_shape{2000, 2000};
+    Element const min{0};
+    Element const max{1};
+
+    auto const near_infrared = uniform(array_shape, partition_shape, min, max);
+    auto const red = uniform(array_shape, partition_shape, min, max);
+    auto const ndvi = (near_infrared - red) / (near_infrared + red);
+
+    int hpx_status = hpx::finalize();
+
+    return hpx_status;
+}
+
+
+auto main(int argc, char* argv[]) -> int
+{
+    std::vector<std::string> const cfg{};
+
+    hpx::init_params params{};
+    params.cfg = {cfg};
+
+    return hpx::init(argc, argv, params);
+}