diff --git a/Cargo.toml b/Cargo.toml index 04e873c..a7d688e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -61,6 +61,10 @@ thiserror.workspace = true path = "crates/specctra-core" features = ["rstar"] +[dependencies.topola-gear-sectors] +path = "crates/topola-gear-sectors" +features = ["serde"] + [dev-dependencies] serde_json.workspace = true diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/crates/topola-gear-sectors/Cargo.toml b/crates/topola-gear-sectors/Cargo.toml new file mode 100644 index 0000000..7b7dfec --- /dev/null +++ b/crates/topola-gear-sectors/Cargo.toml @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: 2024 Topola contributors +# +# SPDX-License-Identifier: MIT OR Apache-2.0 + +[package] +name = "topola-gear-sectors" +version = "0.1.0" +edition = "2021" +license = "MIT OR Apache-2.0" + +[features] +serde = ["smallvec/serde", "dep:serde"] + +[dependencies] +num-traits = "0.2" +smallvec = "1.13" + +[dependencies.serde] +workspace = true +optional = true diff --git a/crates/topola-gear-sectors/src/entry.rs b/crates/topola-gear-sectors/src/entry.rs new file mode 100644 index 0000000..5ad7c10 --- /dev/null +++ b/crates/topola-gear-sectors/src/entry.rs @@ -0,0 +1,155 @@ +// SPDX-FileCopyrightText: 2024 Topola contributors +// +// SPDX-License-Identifier: MIT OR Apache-2.0 +// +// The entry API (interface) and part of the implementation is copied directly from +// Rust's `alloc::collections::btree_map::Entry` (January 2025). +// + +use core::marker::PhantomData; +use smallvec::SmallVec; + +pub enum Entry<'a, K: 'a, V: 'a> { + Occupied(OccupiedEntry<'a, K, V>), + Vacant(VacantEntry<'a, K, V>), +} + +use Entry::*; + +impl<'a, K: 'a, V: 'a> Entry<'a, K, V> { + pub fn position(&self) -> usize { + match self { + Occupied(entry) => entry.position(), + Vacant(entry) => entry.position(), + } + } + + pub fn key(&self) -> &K { + match self { + Occupied(entry) => entry.key(), + Vacant(entry) => entry.key(), + } + } + + pub fn and_modify(self, f: F) -> Self { + match self { + Occupied(mut entry) => { + f(entry.get_mut()); + Occupied(entry) + } + Vacant(entry) => Vacant(entry), + } + } + + pub fn or_insert(self, default: V) -> &'a mut V { + match self { + Occupied(entry) => entry.into_mut(), + Vacant(entry) => entry.insert(default), + } + } + + pub fn or_insert_with V>(self, default: F) -> &'a mut V { + match self { + Occupied(entry) => entry.into_mut(), + Vacant(entry) => entry.insert(default()), + } + } + + pub fn or_insert_with_key V>(self, default: F) -> &'a mut V { + match self { + Occupied(entry) => entry.into_mut(), + Vacant(entry) => { + let value = default(entry.key()); + entry.insert(value) + } + } + } +} + +pub struct OccupiedEntry<'a, K: 'a, V: 'a> { + pub(crate) parent: &'a mut SmallVec<[(K, V); 8]>, + pub(crate) pos: usize, + pub(crate) _marker: PhantomData<&'a mut (K, V)>, +} + +impl<'a, K: 'a, V: 'a> OccupiedEntry<'a, K, V> { + #[inline(always)] + pub fn position(&self) -> usize { + self.pos + } + + #[inline] + pub fn key(&self) -> &K { + &self.parent[self.pos].0 + } + + #[inline] + pub fn get(&self) -> &V { + &self.parent[self.pos].1 + } + + #[inline] + pub fn get_mut(&mut self) -> &mut V { + &mut self.parent[self.pos].1 + } + + #[inline] + pub fn into_mut(self) -> &'a mut V { + &mut self.parent[self.pos].1 + } + + #[inline] + pub fn remove_entry(self) -> (K, V) { + self.parent.remove(self.pos) + } + + #[inline] + pub fn remove(self) -> V { + self.remove_entry().1 + } + + pub fn insert(&mut self, value: V) -> V { + core::mem::replace(&mut self.parent[self.pos].1, value) + } +} + +pub struct VacantEntry<'a, K: 'a, V: 'a> { + pub(crate) parent: &'a mut SmallVec<[(K, V); 8]>, + pub(crate) pos: usize, + pub(crate) key: K, + pub(crate) _marker: PhantomData<&'a mut (K, V)>, +} + +impl<'a, K: 'a, V: 'a> VacantEntry<'a, K, V> { + #[inline(always)] + pub fn position(&self) -> usize { + self.pos + } + + #[inline(always)] + pub fn key(&self) -> &K { + &self.key + } + + #[inline(always)] + pub fn into_key(self) -> K { + self.key + } + + pub fn insert(self, value: V) -> &'a mut V { + self.parent.insert(self.pos, (self.key, value)); + &mut self.parent[self.pos].1 + } + + pub fn insert_entry(self, value: V) -> OccupiedEntry<'a, K, V> { + let VacantEntry { + parent, pos, key, .. + } = self; + parent.insert(pos, (key, value)); + OccupiedEntry { + parent, + pos, + _marker: PhantomData, + } + } +} diff --git a/crates/topola-gear-sectors/src/lib.rs b/crates/topola-gear-sectors/src/lib.rs new file mode 100644 index 0000000..7a34cad --- /dev/null +++ b/crates/topola-gear-sectors/src/lib.rs @@ -0,0 +1,161 @@ +// SPDX-FileCopyrightText: 2024 Topola contributors +// +// SPDX-License-Identifier: MIT OR Apache-2.0 + +use core::{cmp, marker::PhantomData, ops}; +use num_traits::ConstZero; +use smallvec::SmallVec; + +mod entry; +pub use entry::*; + +/// Trait implemented by types which can be used to represent angles +pub trait Angle: Copy + cmp::PartialEq + ConstZero + ops::AddAssign + ops::SubAssign { + /// The value at which 1 winding is indicated + const TAU: Self; + + /// A total comparison operator for angles + fn total_cmp(&self, oth: &Self) -> cmp::Ordering; + + /// Returns true if the number is finite (e.g. [`canonicalize`] terminates normally and not `NaN`) + fn is_finite(&self) -> bool; +} + +impl Angle for f64 { + const TAU: Self = core::f64::consts::TAU; + + #[inline(always)] + fn total_cmp(&self, oth: &Self) -> cmp::Ordering { + f64::total_cmp(self, oth) + } + + #[inline(always)] + fn is_finite(&self) -> bool { + num_traits::float::FloatCore::is_finite(*self) + } +} + +impl Angle for f32 { + const TAU: Self = core::f32::consts::TAU; + + #[inline(always)] + fn total_cmp(&self, oth: &Self) -> cmp::Ordering { + f32::total_cmp(self, oth) + } + + #[inline(always)] + fn is_finite(&self) -> bool { + num_traits::float::FloatCore::is_finite(*self) + } +} + +/// Turn an arbitrary angle into a canonical one (e.g. in range `[0, 2π)`). +/// +/// Panics if passed a non-finite number. +// (If the [`Angle::is_finite`] implementation of `K` is invalid, +// it might infinitely loop instead, or cause undefined behavior.) +pub fn canonicalize(key: &mut K) { + let mut key_ = *key; + assert!(key_.is_finite()); + while key_.total_cmp(&::ZERO) == cmp::Ordering::Less { + key_ += ::TAU; + } + while key_.total_cmp(&::TAU) != cmp::Ordering::Less { + key_ -= ::TAU; + } + *key = key_; +} + +/// Data structure for storing data (`V`) associated to angles (`K`). +/// +/// Note that this can also be used to store the dual (faces) by storing +/// their data at the angle where that sector starts, or even both. +#[derive(Clone, Debug, Default, PartialEq, Hash)] +#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))] +pub struct GearSectors { + // entries ordered by `Angle::total_cmp` + secs: SmallVec<[(K, V); 8]>, +} + +impl GearSectors { + pub fn new() -> Self { + Self { + secs: SmallVec::new(), + } + } + + #[inline(always)] + pub fn secs(&self) -> &[(K, V)] { + &self.secs[..] + } + + #[inline] + pub fn iter_mut<'a>( + &'a mut self, + ) -> impl core::iter::ExactSizeIterator { + self.secs.iter_mut().map(|(k, v)| (&*k, v)) + } + + pub fn entry(&mut self, mut key: K) -> Entry<'_, K, V> { + canonicalize(&mut key); + + match self.secs.binary_search_by(|ent| ent.0.total_cmp(&key)) { + Ok(pos) => Entry::Occupied(OccupiedEntry { + parent: &mut self.secs, + pos, + _marker: PhantomData, + }), + Err(pos) => Entry::Vacant(VacantEntry { + parent: &mut self.secs, + pos, + key, + _marker: PhantomData, + }), + } + } + + /// Calculate the bounds of the sector in which `key` is contained. + /// + /// ## Edge cases + /// * Wraps around at 2π if the map is not empty. + /// * If only a single element with key `y` is contained in the map, returns `y..y`. + pub fn sector_bounds(&self, mut key: K) -> core::ops::Range { + canonicalize(&mut key); + + if self.secs.len() == 0 { + ::ZERO..::TAU + } else { + // `pp`... the first position that is greater than `key` + let pp = self + .secs + .partition_point(|ent| ent.0.total_cmp(&key) != cmp::Ordering::Greater); + (self.secs[pp.wrapping_sub(1).rem_euclid(self.secs.len())].0)..(self.secs[pp].0) + } + } + + /// Retain only the elements specified by the predicate. + /// + /// In other words, remove all elements e such that f(&e) returns false. This method operates in place. + #[inline] + pub fn retain bool>(&mut self, mut f: F) { + self.secs.retain(move |ent| f(&ent.0, &mut ent.1)); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn simple_usage() { + let mut gs = GearSectors::::new(); + + gs.entry(0.1).or_insert(1); + assert_eq!(gs.sector_bounds(0.0), 0.1..0.1); + gs.entry(0.2).or_insert(2); + assert_eq!(gs.secs(), &[(0.1, 1), (0.2, 2),]); + assert_eq!(gs.sector_bounds(0.0), 0.2..0.1); + assert_eq!(gs.sector_bounds(0.1), 0.1..0.2); + assert_eq!(gs.sector_bounds(0.15), 0.1..0.2); + } +}