Add Scalar and related overloads to Python package

computationalgeography · Aug 15, 2024 · 24ee6f3 · 24ee6f3
1 parent 614b8eb
commit 24ee6f3
Show file tree

Hide file tree

Showing 172 changed files with 2,249 additions and 1,822 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -7,14 +7,8 @@ charset = utf-8
 indent_style = space
 indent_size = 4
 insert_final_newline = true
-max_line_length = 80
-trim_trailing_whitespace = true
-
-[*.{c,cpp,h,hpp,md,rb,rst,txt,yaml,yml}]
 max_line_length = 110
-
-[*.py]
-max_line_length = 90
+trim_trailing_whitespace = true
 
 [*.yml]
 indent_size = 2
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(
-    VERSION 3.26)
+    VERSION 3.28)
 project(LUE
     VERSION 0.3.8
     LANGUAGES C CXX

diff --git a/document/doc/CMakeLists.txt b/document/doc/CMakeLists.txt
@@ -32,6 +32,7 @@ foreach(name IN ITEMS
     about/publication.md
     about/related.md
     about/release.md
+    about/short_description.md
     contribute/documentation.md
     contribute/index.md
     contribute/release.md
@@ -63,25 +64,25 @@ foreach(name IN ITEMS
     reference/c/index.md
     reference/cpp/index.md
     reference/index.md
-    reference/java/index.md
-    reference/julia/index.md
+    # reference/fortran/index.md
+    # reference/java/index.md
+    # reference/julia/index.md
     reference/operation/index.md
     reference/operation/uniform.md
     # reference/python/data_model/index.rst
     # reference/python/data_model/hdf5/index.rst
     # reference/python/data_model/index.rst
     # reference/python/framework/index.rst
     reference/python/index.md
-    reference/r/index.md
-    reference/rust/index.md
+    # reference/r/index.md
+    # reference/rust/index.md
     references.bib
     reference/utility/index.md
     reference/utility/lue_calculate.md
     reference/utility/lue_scalability.md
     reference/utility/lue_translate.md
     reference/utility/lue_validate.md
     reference/utility/lue_view.md
-    short_description.md
     _toc.yml
 )
     configure_file(${name} ${name} COPYONLY)
@@ -98,6 +99,9 @@ foreach(name IN ITEMS
     framework/algorithm/doc/policy/range.md
     framework/algorithm/doc/template.md
 
+    framework/api/doc/index.md
+    framework/api/cxx/doc/index.md
+
     framework/doc/test/index.md
 
     framework/doc/howto/index.md
@@ -115,6 +119,7 @@ foreach(name IN ITEMS
     framework/algorithm/doc/grouped_operation/array_operation.md
     framework/algorithm/doc/grouped_operation/random_number_operation.md
 
+    framework/core/doc/index.md
     framework/partitioned_array/doc/index.md
     framework/partitioned_route/doc/index.md
 

diff --git a/document/doc/_toc.yml b/document/doc/_toc.yml
@@ -35,12 +35,18 @@ parts:
       - file: reference/operation/index.md
         sections:
         - file: reference/operation/uniform.md
-      - file: reference/c/index.md
-      - file: reference/cpp/index.md
-      - file: reference/java/index.md
-      - file: reference/julia/index.md
-      - file: reference/python/index.md
-      - file: reference/r/index.md
+      - file: source/framework/api/doc/index.md
+        sections:
+        - file: reference/c/index.md
+        - file: reference/cpp/index.md
+          sections:
+          - file: source/framework/api/cxx/doc/index.md
+        # - file: reference/fortran/index.md
+        # - file: reference/java/index.md
+        # - file: reference/julia/index.md
+        - file: reference/python/index.md
+        # - file: reference/r/index.md
+        # - file: reference/rust/index.md
       - file: reference/utility/index.md
         sections:
         - file: reference/utility/lue_calculate.md
@@ -70,6 +76,7 @@ parts:
       - file: source/data_model/doc/index.md
       - file: source/framework/doc/index.md
         sections:
+        - file: source/framework/core/doc/index.md
         - file: source/framework/partitioned_array/doc/index.md
         - file: source/framework/partitioned_route/doc/index.md
         - file: source/framework/algorithm/doc/index.md

diff --git a/document/doc/short_description.md → document/doc/about/short_description.md b/document/doc/short_description.md → document/doc/about/short_description.md
diff --git a/document/doc/reference/cpp/index.md b/document/doc/reference/cpp/index.md
@@ -1,3 +1 @@
 # C++ reference [WIP]
-
-Work in progress.
diff --git a/document/doc/reference/fortran/index.md b/document/doc/reference/fortran/index.md
@@ -0,0 +1,4 @@
+# Fortran reference [TODO]
+
+If Fortran language bindings to LUE interest you, you may want to [help us](#doc-contribute) adding them. Do
+[contact](https://lue.computationalgeography.org/) us if you want to discuss this.
diff --git a/environment/cmake/LueConfiguration.cmake b/environment/cmake/LueConfiguration.cmake
@@ -122,17 +122,6 @@ if(LUE_BUILD_DATA_MODEL)
 endif()
 
 
-if(LUE_BUILD_QA)
-    if(LUE_QA_WITH_TESTS)
-        set(ENV{CTEST_OUTPUT_ON_FAILURE} "1")
-    endif()
-endif()
-
-
-if(LUE_BUILD_DOCUMENTATION)
-endif()
-
-
 set(LUE_TEMPLATIZE "${PROJECT_SOURCE_DIR}/environment/script/templatize.py")
 
 # NOTE These can be made configurable later on

diff --git a/environment/cmake/lue_package.cmake b/environment/cmake/lue_package.cmake
@@ -7,7 +7,7 @@ set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
 set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
 set(CPACK_PACKAGE_INSTALL_DIRECTORY ${CPACK_PACKAGE_NAME})
 set(CPACK_PACKAGE_DESCRIPTION_FILE
-    ${${PROJECT_NAME}_SOURCE_DIR}/document/doc/short_description.md)
+    ${${PROJECT_NAME}_SOURCE_DIR}/document/doc/about/short_description.md)
 
 set(CPACK_SOURCE_PACKAGE_FILE_NAME ${LUE_LOWER_PROJECT_NAME}-${LUE_VERSION})
 set(CPACK_SOURCE_IGNORE_FILES

diff --git a/source/framework/algorithm/doc/index.md b/source/framework/algorithm/doc/index.md
@@ -1,4 +1,4 @@
-# Algorithms
+# `lue_framework_algorithm`
 
 
 These are top-level algorithms that can be called in any order. They take one or more partitioned arrays as

diff --git a/source/framework/algorithm/include/lue/framework/algorithm/add.hpp b/source/framework/algorithm/include/lue/framework/algorithm/add.hpp
@@ -33,6 +33,6 @@ namespace lue {
     }  // namespace policy::add
 
 
-    LUE_BINARY_LOCAL_OPERATION_OVERLOADS4(add, detail::Add)
+    LUE_BINARY_LOCAL_OPERATION_OVERLOADS_WITH_POLICIES(add, detail::Add)
 
 }  // namespace lue
diff --git a/source/framework/algorithm/include/lue/framework/algorithm/all.hpp b/source/framework/algorithm/include/lue/framework/algorithm/all.hpp
@@ -56,7 +56,7 @@ namespace lue {
 
 
     template<typename Policies, typename Element, Rank rank>
-    hpx::future<Element> all(Policies const& policies, PartitionedArray<Element, rank> const& array)
+    auto all(Policies const& policies, PartitionedArray<Element, rank> const& array) -> Scalar<Element>
     {
         using Functor = detail::All<Element>;
 
@@ -65,10 +65,10 @@ namespace lue {
 
 
     template<typename Policies, typename Element, Rank rank>
-    hpx::future<Element> all(
+    auto all(
         hpx::id_type const locality_id,
         Policies const& policies,
-        ArrayPartition<Element, rank> const& partition)
+        ArrayPartition<Element, rank> const& partition) -> Scalar<Element>
     {
         using Functor = detail::All<Element>;
 

diff --git a/source/framework/algorithm/include/lue/framework/algorithm/any.hpp b/source/framework/algorithm/include/lue/framework/algorithm/any.hpp
@@ -73,7 +73,7 @@ namespace lue {
 
 
     template<typename Element, Rank rank>
-    hpx::future<Element> any(PartitionedArray<Element, rank> const& array)
+    auto any(PartitionedArray<Element, rank> const& array) -> Scalar<Element>
     {
         using Functor = detail::Any<Element>;
         using Policies = policy::any::DefaultPolicies<Element>;