Update Docs

docs/benchmarks.md

@@ -7,7 +7,8 @@ has_toc: false
 ---
 # Benchmarks
 
-The default tag for fronts and archives is converted to an appropriate data structure according to the front or archive parameters. This section presents some benchmarks comparing these data structures. We use the notation `L`, `Q`, `K`, `B`, `R`, and `*` for Lists, Quadtrees, <img src="https://render.githubusercontent.com/render/math?math=k">-d trees, Boost.Geomtry R-trees, Point R-trees, and R*-Trees. The tree data structures in the benchmark used a [memory pool allocator](https://github.com/alandefreitas/pareto-front/blob/master/source/pareto_front/memory_pool.h) for faster allocation. This is intented to make trees more competitive with linear lists for small fronts. If using this code in production, it is more prudent to use [`std::pmr::unsynchronized_pool_resource`](https://en.cppreference.com/w/cpp/memory/unsynchronized_pool_resource/unsynchronized_pool_resource) (if your compiler supports it), [`std::allocator`](https://en.cppreference.com/w/cpp/memory/allocator) (if you want to be conservative), or execute *many* tests to make sure [`pareto::fast_memory_pool`](https://github.com/alandefreitas/pareto-front/blob/master/sources/pareto_front/memory_pool.h) works properly on your system.
+The default tag for fronts and archives is converted to an appropriate data structure according to the front or archive parameters. This section presents some benchmarks comparing these data structures. We use the notation `L`, `Q`, `K`, `B`, `R`, and `*` for Lists, Quadtrees, <img src="https://render.githubusercontent.com/render/math?math=k">-d trees, Boost.Geomtry R-trees, Point R-trees, and R*-Trees. The tree data structures in the benchmark used a [memory pool allocator](https://github.com/alandefreitas/pareto-front/blob/master/) for faster allocation. This is intented to make trees more competitive with linear lists for small fronts. If using this code in production, it is more prudent to use [`std::pmr::unsynchronized_pool_resource`](https://en.cppreference.com/w/cpp/memory/unsynchronized_pool_resource/unsynchronized_pool_resource) (if your compiler supports it), [`std::allocator`](https://en.cppreference.com/w/cpp/memory/allocator) (if you want to be conservative), or execute *many* tests to make sure [`pareto::fast_memory_pool`](https://github.com/alandefreitas/pareto-front/blob/master/) works properly on your system.
+
 
 Constructor
 

docs/contributing.md

@@ -9,12 +9,12 @@ has_toc: false
 
 There are many ways in which you can contribute to this library:
 
-* Testing the library in new environments <sup>see [1](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+windows%22), [2](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+linux%22), [3](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+macos%22) </sup>
+* Testing the library in new environments <sup>see [1](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+windows%22), [2](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+linux%22), [3](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22cross-platform+issue+-+macos%22) </sup>
 * Contributing with interesting examples <sup>see [1](https://github.com/alandefreitas/pareto-front/blob/master/examples)</sup>
 * Including new indicators <sup>see [1](examples/indicators.md)</sup>
-* Improving this documentation <sup>see [1](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+documentation%22) </sup>
-* New spacial data structures <sup>see [1](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+data+structures%22) </sup>
-* Finding bugs in general <sup>see [1](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+error%22), [2](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+warning%22), [3](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+error%22), [4](https://github.com/alandefreitas/pareto-front/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+warning%22) </sup>
+* Improving this documentation <sup>see [1](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+documentation%22) </sup>
+* New spacial data structures <sup>see [1](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+-+data+structures%22) </sup>
+* Finding bugs in general <sup>see [1](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+error%22), [2](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+compilation+warning%22), [3](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+error%22), [4](https://github.com/alandefreitas/pareto/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+-+runtime+warning%22) </sup>
 * Whatever idea seems interesting to you
 
 If contributing with code, please leave the pedantic mode ON (`-DBUILD_WITH_PEDANTIC_WARNINGS=ON`).

docs/examples/constructing-fronts.md

@@ -15,10 +15,10 @@ import pyfront
 pf = pyfront.front(2)
 ```
 
-C++, assuming we are in the `pareto` namespace:
+C++, assuming we are in the `pareto_front` namespace:
 
 ```cpp
-#include <pareto/front.h>
+#include <pareto_front/front.h>
 front<double, 2, unsigned> pf;
 ```
 

docs/index.md

@@ -9,7 +9,7 @@ has_toc: false
 
 > Efficient Pareto fronts and archives for Python and C++
 
-[![Two-dimensional front](img/pareto_cover.svg)](https://alandefreitas.github.io/pareto-front/)
+[![Two-dimensional front](img/pareto_cover.svg)](https://alandefreitas.github.io/pareto/)
 
 <br/>
 
@@ -18,23 +18,23 @@ This library provides a STL-like container representing a data structure to cach
 
 <br/>
 
-[![Build Status](https://img.shields.io/github/workflow/status/alandefreitas/pareto-front/ParetoFront?event=push&label=Build&logo=Github-Actions)](https://github.com/alandefreitas/pareto-front/actions?query=workflow%3AParetoFront+event%3Apush)
-[![Latest Release](https://img.shields.io/github/release/alandefreitas/pareto-front.svg?label=Download)](https://GitHub.com/alandefreitas/pareto-front/releases/)
-[![Website lbesson.bitbucket.org](https://img.shields.io/website-up-down-green-red/http/alandefreitas.github.io/pareto-front.svg?label=Documentation)](https://alandefreitas.github.io/pareto-front/)
+[![Build Status](https://img.shields.io/github/workflow/status/alandefreitas/pareto/ParetoFront?event=push&label=Build&logo=Github-Actions)](https://github.com/alandefreitas/pareto/actions?query=workflow%3AParetoFront+event%3Apush)
+[![Latest Release](https://img.shields.io/github/release/alandefreitas/pareto.svg?label=Download)](https://GitHub.com/alandefreitas/pareto/releases/)
+[![Website lbesson.bitbucket.org](https://img.shields.io/website-up-down-green-red/http/alandefreitas.github.io/pareto.svg?label=Documentation)](https://alandefreitas.github.io/pareto/)
 
 <br/>
 
 <!-- https://github.com/bradvin/social-share-urls -->
-[![Facebook](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Facebook&logo=facebook)](https://www.facebook.com/sharer/sharer.php?t=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&u=https://github.com/alandefreitas/pareto-front/)
-[![QZone](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+QZone&logo=qzone)](http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https://github.com/alandefreitas/pareto-front/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&summary=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![Weibo](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Weibo&logo=sina-weibo)](http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https://github.com/alandefreitas/pareto-front/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&summary=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![Reddit](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Reddit&logo=reddit)](http://www.reddit.com/submit?url=https://github.com/alandefreitas/pareto-front/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?label=Share+on+Twitter&style=social)](https://twitter.com/intent/tweet?text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&url=https://github.com/alandefreitas/pareto-front/&hashtags=MOO,MultiObjectiveOptimization,Cpp,ScientificComputing,Optimization,Developers)
-[![LinkedIn](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+LinkedIn&logo=linkedin)](https://www.linkedin.com/shareArticle?mini=false&url=https://github.com/alandefreitas/pareto-front/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![WhatsApp](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+WhatsApp&logo=whatsapp)](https://api.whatsapp.com/send?text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python:+https://github.com/alandefreitas/pareto-front/)
-[![Line.me](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Line.me&logo=line)](https://lineit.line.me/share/ui?url=https://github.com/alandefreitas/pareto-front/&text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![Telegram.me](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Telegram.me&logo=telegram)](https://telegram.me/share/url?url=https://github.com/alandefreitas/pareto-front/&text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
-[![HackerNews](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+HackerNews&logo=y-combinator)](https://news.ycombinator.com/submitlink?u=https://github.com/alandefreitas/pareto-front/&t=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![Facebook](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Facebook&logo=facebook)](https://www.facebook.com/sharer/sharer.php?t=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&u=https://github.com/alandefreitas/pareto/)
+[![QZone](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+QZone&logo=qzone)](http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https://github.com/alandefreitas/pareto/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&summary=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![Weibo](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Weibo&logo=sina-weibo)](http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https://github.com/alandefreitas/pareto/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&summary=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![Reddit](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Reddit&logo=reddit)](http://www.reddit.com/submit?url=https://github.com/alandefreitas/pareto/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?label=Share+on+Twitter&style=social)](https://twitter.com/intent/tweet?text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python&url=https://github.com/alandefreitas/pareto/&hashtags=MOO,MultiObjectiveOptimization,Cpp,ScientificComputing,Optimization,Developers)
+[![LinkedIn](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+LinkedIn&logo=linkedin)](https://www.linkedin.com/shareArticle?mini=false&url=https://github.com/alandefreitas/pareto/&title=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![WhatsApp](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+WhatsApp&logo=whatsapp)](https://api.whatsapp.com/send?text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python:+https://github.com/alandefreitas/pareto/)
+[![Line.me](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Line.me&logo=line)](https://lineit.line.me/share/ui?url=https://github.com/alandefreitas/pareto/&text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![Telegram.me](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+Telegram.me&logo=telegram)](https://telegram.me/share/url?url=https://github.com/alandefreitas/pareto/&text=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
+[![HackerNews](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Share+on+HackerNews&logo=y-combinator)](https://news.ycombinator.com/submitlink?u=https://github.com/alandefreitas/pareto/&t=Pareto%20Fronts%20and%20Archives%20/%20C%2B%2B%20and%20Python)
 
 <br/>
 
@@ -59,7 +59,7 @@ This library provides a STL-like container representing a data structure to cach
   - [Build from source](integration/build-from-source.md)
     - [Dependencies](integration/build-from-source/dependencies.md)
     - [Build the Examples](integration/build-from-source/build-the-examples.md)
-    - [Installing pareto-front from Source](integration/build-from-source/installing-pareto-front-from-source.md)
+    - [Installing pareto from Source](integration/build-from-source/installing-pareto-from-source.md)
     - [Building the packages](integration/build-from-source/building-the-packages.md)
   - [CMake targets](integration/cmake-targets.md)
     - [Find it as a CMake Package](integration/cmake-targets/find-it-as-a-cmake-package.md)

docs/integration.md

@@ -12,7 +12,7 @@ has_toc: false
 - [Build from source](integration/build-from-source.md)
   - [Dependencies](integration/build-from-source/dependencies.md)
   - [Build the Examples](integration/build-from-source/build-the-examples.md)
-  - [Installing pareto-front from Source](integration/build-from-source/installing-pareto-front-from-source.md)
+  - [Installing pareto from Source](integration/build-from-source/installing-pareto-from-source.md)
   - [Building the packages](integration/build-from-source/building-the-packages.md)
 - [CMake targets](integration/cmake-targets.md)
   - [Find it as a CMake Package](integration/cmake-targets/find-it-as-a-cmake-package.md)

docs/integration/build-from-source.md

@@ -11,7 +11,7 @@ has_toc: false
 
 - [Dependencies](build-from-source/dependencies.md)
 - [Build the Examples](build-from-source/build-the-examples.md)
-- [Installing pareto-front from Source](build-from-source/installing-pareto-front-from-source.md)
+- [Installing pareto from Source](build-from-source/installing-pareto-from-source.md)
 - [Building the packages](build-from-source/building-the-packages.md)
 
 

docs/integration/build-from-source/building-the-packages.md

@@ -9,7 +9,7 @@ has_toc: false
 ---
 # Building the packages
 
-This will create the binary packages you can use to install pareto-front on your system:
+This will create the binary packages you can use to install pareto on your system:
 
 ```bash
 mkdir build

docs/integration/build-from-source/dependencies.md

@@ -9,7 +9,7 @@ has_toc: false
 ---
 # Dependencies
 
-This section lists the dependencies you need before installing pareto-front from source. The build script will try to find all these dependencies for you:
+This section lists the dependencies you need before installing pareto from source. The build script will try to find all these dependencies for you:
 
 * C++17
 * CMake 3.14 or higher

docs/integration/build-from-source/installing-pareto-front-from-source.md → docs/integration/build-from-source/installing-pareto-from-source.md

@@ -1,15 +1,15 @@
 ---
 layout: default
-title: Installing pareto-front from Source
+title: Installing pareto from Source
 nav_order: 3
 has_children: false
 parent: Build from source
 grand_parent: Integration
 has_toc: false
 ---
-# Installing pareto-front from Source
+# Installing pareto from Source
 
-This will install pareto-front on your system:
+This will install pareto on your system:
 
 ```bash
 mkdir build

docs/integration/cmake-targets/cmake-with-automatic-download.md

@@ -20,23 +20,23 @@ Install [CPM.cmake](https://github.com/TheLartians/CPM.cmake) and then:
 ```cmake
 CPMAddPackage(
     NAME ParetoFront
-    GITHUB_REPOSITORY alandefreitas/pareto-front
+    GITHUB_REPOSITORY alandefreitas/pareto
     GIT_TAG origin/master # or whatever tag you want
 )
 # ...
-target_link_libraries(my_target PUBLIC pareto-front)
+target_link_libraries(my_target PUBLIC pareto)
 ```
 
 Then add this header to your source files:
 
 ```cpp
-#include <pareto/front.h>
+#include <pareto_front/front.h>
 ```
 
 Or to use Pareto archives:
 
 ```cpp
-#include <pareto/archives.h>
+#include <pareto_front/archives.h>
 ```
 
 However, it's always recommended to look for ParetoFront with `find_package` before including it as a subdirectory. You can use:

docs/integration/cmake-targets/find-it-as-a-cmake-package.md

@@ -27,13 +27,13 @@ target_link_libraries(my_target PUBLIC pareto_front)
 Add this header to your source files:
 
 ```cpp
-#include <pareto/front.h>
+#include <pareto_front/front.h>
 ```
 
 Or to use Pareto archives:
 
 ```cpp
-#include <pareto/archives.h>
+#include <pareto_front/archives.h>
 ```
 
 

docs/integration/cmake-targets/use-it-as-a-cmake-subdirectory.md

@@ -9,7 +9,7 @@ has_toc: false
 ---
 # Use it as a CMake subdirectory
 
-You can use pareto-front directly in CMake projects without installing it. Check if you have [Cmake](http://cmake.org) 3.14+ installed:
+You can use pareto directly in CMake projects without installing it. Check if you have [Cmake](http://cmake.org) 3.14+ installed:
 
 ```bash
 cmake -version
@@ -18,32 +18,32 @@ cmake -version
 Clone the whole project
 
 ```bash
-git clone https://github.com/alandefreitas/pareto-front/
+git clone https://github.com/alandefreitas/pareto/
 ```
 
 and add the subdirectory to your CMake project:
 
 ```cmake
-add_subdirectory(pareto-front)
+add_subdirectory(pareto)
 ```
 
 When creating your executable, link the library to the targets you want:
 
 ```
 add_executable(my_target main.cpp)
-target_link_libraries(my_target PUBLIC pareto-front)
+target_link_libraries(my_target PUBLIC pareto)
 ```
 
 Add this header to your source files:
 
 ```cpp
-#include <pareto/front.h>
+#include <pareto_front/front.h>
 ```
 
 Or to use Pareto archives:
 
 ```cpp
-#include <pareto/archives.h>
+#include <pareto_front/archives.h>
 ```
 
 However, it's always recommended to look for ParetoFront with `find_package` before including it as a subdirectory. Otherwise, we can get [ODR errors](https://en.wikipedia.org/wiki/One_Definition_Rule) in larger projects. 

docs/integration/other-build-systems.md

@@ -10,18 +10,18 @@ has_toc: false
 
 If you want to use it in another build system you can either install the library (Section [*Installing*](#installing)) or you have to somehow rewrite the build script.
 
-If you want to rewrite the build script, your project needs to 1) include the headers and compile all source files in the [`source`](https://github.com/alandefreitas/pareto-front/blob/master/sources) directory, and 2) link the dependencies described in [`sources/CMakeLists.txt`](https://github.com/alandefreitas/pareto-front/blob/master/sources/CMakeLists.txt).
+If you want to rewrite the build script, your project needs to 1) include the headers and compile all source files in the [`sources`](https://github.com/alandefreitas/pareto-front/blob/master/) directory, and 2) link the dependencies described in [`sources/CMakeLists.txt`](https://github.com/alandefreitas/pareto-front/blob/master/).
 
 Then add this header to your source files:
 
 ```cpp
-#include <pareto/front.h>
+#include <pareto_front/front.h>
 ```
 
 Or to use Pareto archives:
 
 ```cpp
-#include <pareto/archives.h>
+#include <pareto_front/archives.h>
 ```