Fix Issues with Shifting of Insets to Position and String to Decimal Converter

CMakeLists.txt

@@ -27,7 +27,7 @@ set(CGAL_DIR ${PROJECT_SOURCE_DIR}/external/cgal)
 find_package(CGAL REQUIRED)
 
 # Boost
-find_package(Boost REQUIRED COMPONENTS unit_test_framework)
+find_package(Boost REQUIRED CONFIG COMPONENTS unit_test_framework)
 
 # PkgConfig, fftw, and cairo
 find_package(PkgConfig REQUIRED)

README.md

@@ -48,6 +48,14 @@ Have a look through to apt-requirements.txt if you'd like to see what all will b
 apt install -y g++-11 build-essential cmake libboost-all-dev nlohmann-json3-dev libomp-dev libfftw3-dev libcairo2-dev
 ```
 
+### Using WSL (Windows Subsystem for Linux)
+
+For Windows users, we recommend using our program through Windows Subsystem for Linux (WSL).
+
+Please install [Ubuntu](https://apps.microsoft.com/detail/9pdxgncfsczv) from the Microsoft Store, and then follow the same instructions as for Debian-based distributions (found above).
+
+We recommend you to compile anywhere outside the `/mnt` directory, as compiling in the `/mnt` directory may lead to unexpected behavior.
+
 ### Installation
 
 Go to the `cartogram-cpp` directory in your preferred terminal and execute the following commands.
@@ -120,12 +128,6 @@ cartogram sample_data/world_by_country_since_2022/world_by_country_since_2022.ge
 
 You may inspect the resultant SVG to check if everything looks as expected.
 
-### Contributing
-
-Contributions are highly encouraged! Please feel free to take a stab at any at any of the open issues and send in a pull request. If you need help getting setup or more guidance contributing, please @ any of the main contributors (@adisidev, @nihalzp, @mgastner) under any of the open issues (or after creating your own issue), and we'll be happy to guide you!
-
-Maintainers, please make sure to run the "Build and Release" workflow under GitHub Actions before approving the pull request. You may delete the newly created release before merging the pull-request. Another release should be automatically created after merging with main.
-
 ### Testing
 
 If you'd like to contribute to the project, please run our tests after you make any changes.
@@ -144,6 +146,26 @@ Additionally, you may go to the `cartogram-cpp/tests` directory and run the foll
 bash stress_test.sh
 ```
 
+### Benchmarking
+
+To benchmark the program, first install [hyperfine](https://github.com/sharkdp/hyperfine). You can install it using Homebrew on macOS:
+
+```shell script
+brew install hyperfine
+```
+
+Or using apt on Debian-based distributions:
+
+```shell script
+apt install hyperfine
+```
+
+Then, go to the `cartogram-cpp/tests` directory and run the following command:
+
+```shell script
+bash stress_test.sh
+```
+
 ### Uninstallation
 
 Go to the `cartogram-cpp` directory in your preferred terminal and execute the following command:
@@ -157,3 +179,14 @@ Upon successful uninstallation, the following will be outputted:
     > Built target uninstall
 
 Further, running `cartogram` should no longer work.
+
+### Pushing changes to [go-cart.io](https://go-cart.io)
+
+To push changes to production, please follow the the instructions on [go-cart-io/carotgram-docker](https://github.com/go-cart-io/cartogram-docker).
+
+
+### Contributing
+
+Contributions are highly encouraged! Please feel free to take a stab at any at any of the open issues and send in a pull request. If you need help getting setup or more guidance contributing, please @ any of the main contributors (@adisidev, @nihalzp, @mgastner) under any of the open issues (or after creating your own issue), and we'll be happy to guide you!
+
+Maintainers, please make sure to run the "Build and Release" workflow under GitHub Actions before approving the pull request. You may delete the newly created release before merging the pull-request. Another release should be automatically created after merging with main.

include/cartogram_info.hpp

@@ -10,21 +10,24 @@ class CartogramInfo
   std::map<std::string, std::string> gd_to_inset_;
   std::string id_header_;
   std::set<std::string> ids_in_visual_variables_file_;
+  std::vector<std::string> initial_id_order_;
   std::map<std::string, InsetState> inset_states_;
   bool is_world_map_;
   std::string map_name_;
+  std::map<std::string, std::map<std::string, std::string>> properties_map_;
+  std::vector<std::string> unique_properties_;
 
   // TODO: We assume that either all external rings are counterclockwise or
   //       all are clockwise. This dichotomy covers most geospatial boundary
   //       files in the wild, but it would still be sensible to allow cases
   //       where there are external rings with opposite winding directions.
   bool original_ext_ring_is_clockwise_{};
-  std::string visual_variable_file_;
   nlohmann::json cgal_to_json(bool = false);
 
 public:
-  explicit CartogramInfo(bool, const std::string &);
+  explicit CartogramInfo(bool);
   [[nodiscard]] double cart_initial_total_target_area() const;
+  void construct_inset_state_from_geodivs(const nlohmann::json &);
   [[nodiscard]] double area() const;
   [[nodiscard]] bool is_world_map() const;
   void json_to_geojson(
@@ -36,11 +39,21 @@ class CartogramInfo
   void read_csv(const argparse::ArgumentParser &);
   void read_geojson(const std::string &, bool, std::string &);
   std::map<std::string, InsetState> &ref_to_inset_states();
+  void relocate_geodivs_based_on_inset_pos(
+    const std::map<std::string, std::map<std::string, std::string>> &);
   void replace_missing_and_zero_target_areas();
   std::string set_map_name(const std::string &);
-  void shift_insets_to_target_position();
+  void set_id_header(const std::string &);
+  void shift_insets_to_target_position(bool output_to_stdout = false);
+  void update_id_header_info(const std::string &);
   void write_csv(const std::string &csv_file_name);
-  void write_geojson(const std::string &, const std::string &, bool = false);
+  void write_geojson(
+    const std::string &,
+    const std::string &,
+    bool = false,
+    bool = false);
+  InsetState convert_to_inset_state();
+  void write_svg(const std::string &suffix = "");
 };
 
-#endif // CARTOGRAM_INFO_HPP_
+#endif  // CARTOGRAM_INFO_HPP_

include/geo_div.hpp

@@ -35,6 +35,7 @@ class GeoDiv
   void push_back(const Polygon_with_holes &);
   std::vector<Polygon_with_holes> &ref_to_polygons_with_holes();
   void sort_pwh_descending_by_area();
+  void update_id(const std::string &);
 };
 
-#endif // GEO_DIV_HPP_
+#endif  // GEO_DIV_HPP_

include/inset_state.hpp

@@ -168,8 +168,6 @@ class InsetState
     const double total_inset_area);
   Bbox get_bbox_bar(const double bar_width, const double bar_height);
 
-  GeoDiv &get_geo_div(const std::string &);
-
   std::pair<double, unsigned int> get_km_legend_length();
   std::pair<double, unsigned int> get_visual_variable_legend_length();
 
@@ -182,7 +180,10 @@ class InsetState
   void insert_color(const std::string &, const Color &);
   void insert_color(const std::string &, std::string &);
   bool insert_constraint_safely(const Point &p1, const Point &p2);
-  bool insert_constraint_safely_to_dt(Delaunay &dt, const Point &p1, const Point &p2);
+  bool insert_constraint_safely_to_dt(
+    Delaunay &dt,
+    const Point &p1,
+    const Point &p2);
   void insert_label(const std::string &, const std::string &);
   void insert_target_area(const std::string &, double);
   void insert_whether_input_target_area_is_missing(const std::string &, bool);
@@ -193,7 +194,7 @@ class InsetState
     char,
     unsigned int) const;
   bool is_input_target_area_missing(const std::string &) const;
-  void is_simple(const char* caller_func) const;
+  void is_simple(const char *caller_func) const;
   std::string label_at(const std::string &) const;
   double latt_const() const;
   unsigned int lx() const;
@@ -211,7 +212,10 @@ class InsetState
   unsigned int n_geo_divs() const;
   unsigned long n_points() const;
   unsigned int n_rings() const;
-  void normalize_inset_area(double total_cart_target_area, bool = false);
+  void normalize_inset_area(
+    double total_cart_target_area,
+    bool equal_area = false,
+    bool normalize_original = false);
   void normalize_target_area();
   std::string pos() const;
   void project();
@@ -235,12 +239,12 @@ class InsetState
   void set_geo_divs(std::vector<GeoDiv> new_geo_divs);
   void set_inset_name(const std::string &);
   void store_initial_area();
-  void store_initial_target_area();
+  void store_initial_target_area(const double override = 0.0);
   void simplify(unsigned int);
   void store_original_geo_divs();
   double target_area_at(const std::string &) const;
   bool target_area_is_missing(const std::string &) const;
-  double total_inset_area() const;
+  double total_inset_area(bool = false) const;
   double total_target_area() const;
   Polygon transform_to_equal_area_projection_coor(Polygon edge_points);
   std::array<Point, 3> transformed_triangle(
@@ -249,16 +253,21 @@ class InsetState
 
   // Apply given function to all points
   void transform_points(const std::function<Point(Point)> &, bool = false);
+  void transform_polygons(const std::function<Polygon(Polygon)> &, bool = false);
+  void scale_points(double scale_factor, bool project_original = false);
+  void move_points(double dx, double dy, bool project_original = false);
   std::array<Point, 3> untransformed_triangle(const Point &, bool = false)
     const;
   void trim_grid_heatmap(cairo_t *cr, double padding);
   void update_delaunay_t();
+  void update_gd_ids(const std::map<std::string, std::string> &);
 
   // Cairo functions
   void write_cairo_map(
     const std::string &,
     bool,
-    const std::unordered_map<Point, Vector> = std::unordered_map<Point, Vector>()) const;
+    const std::unordered_map<Point, Vector> =
+      std::unordered_map<Point, Vector>()) const;
   void write_cairo_polygons_to_svg(
     const std::string &,
     bool,
@@ -281,11 +290,11 @@ class InsetState
     cairo_t *cr,
     const bool fill_polygons,
     const bool colors,
-    const bool plot_equal_area_map) const;
+    const bool plot_equal_area_map,
+    const double line_width = 0.0) const;
   void write_labels_on_surface(cairo_t *cr);
   void write_density_image(
     const std::string filename,
-    const double *density,
     const bool plot_pycnophylactic);
   void write_intersections_image(unsigned int res);
   void write_legend_on_surface(cairo_t *cr, bool equal_area_map);

include/parse_arguments.hpp

@@ -23,7 +23,7 @@ argparse::ArgumentParser parsed_arguments(
   bool &plot_intersections,
   bool &plot_polygons,
   bool &remove_tiny_polygons,
-  double &minimum_polygon_area,
+  double &min_polygon_area,
   bool &plot_quadtree,
   bool &rays,
   bool &output_preprocessed);

include/string_to_decimal_converter.hpp

@@ -2,6 +2,7 @@
 #define STRING_TO_DECIMAL_CONVERTER_H
 
 #include <string>
+#include <vector>
 
 class StringToDecimalConverter
 {
@@ -13,16 +14,16 @@ class StringToDecimalConverter
 
   static bool is_valid_char(char ch);
   static std::string remove_char(std::string str, char ch);
-  static int count_char(const std::string &str, char ch);
   static bool has_multiple_commas_and_points(const std::string &str);
   static bool has_separator_at_the_end(const std::string &str);
   static bool has_invalid_comma_point_sequence(const std::string &str);
 
 public:
+  static bool is_comma_as_separator(const std::vector<std::string> &strs);
   static bool is_str_NA(const std::string &str);
   static bool is_str_valid_characters(const std::string &str);
   static bool is_str_correct_format(const std::string &str);
-  static double parse_str(const std::string &str);
+  static std::string parse_str(const std::string &str, bool);
 };
 
 #endif  // STRING_TO_DECIMAL_CONVERTER_H