1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
use std::cmp::Ordering; use std::convert::TryInto; use std::mem; #[cfg(test)] mod tests { use crate::*; #[test] fn test_increment_coordinates_beyond_bit_range() { // Test that the increment doesn't increment out of bounds let mut loop_coords = vec![0, 0]; for _incr_count in 0..1024 { coordinates_increment(4, &mut loop_coords); assert!(loop_coords[0] < 16, "x = {} < 16", loop_coords[0]); assert!(loop_coords[1] < 16, "y = {} < 16", loop_coords[1]); } } #[test] fn test_iterate_dimensions() { // 2 dimensions each using 4 bits for x in 0..1 << 4 { for y in 0..1 << 4 { let coords = vec![x, y]; let _index = coordinates_to_index(4, &coords); } } } } /// Represent an index on the Hilbert curve pub type HilbertIndex = moore_hilbert_sys::BitmaskT; /// Storage type for a single coordinate pub type HilbertCoordinate = u64; /// The datatype that contain the number of bits per dimension pub type BitsPerDimensionType = usize; /// The number of bits in each byte const BITS_PER_BYTE: usize = 8; /// Convert coordinates of a point on a Hilbert curve to its index /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits/coordinate. /// * `coords` - Slice of coordinate values /// /// # Returns /// /// * `index` - Output index value. nDims*nBits bits. /// /// # Assumptions /// /// `length of coords` * `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// /// # Example /// /// ``` /// let bits_per_dimension = 8; /// let r = moore_hilbert::coordinates_to_index(bits_per_dimension, &vec![1,2,3]).unwrap(); /// assert_eq!(r, 36); /// ``` pub fn coordinates_to_index( bits_per_dimension: BitsPerDimensionType, coords: &[HilbertCoordinate], ) -> Result<HilbertIndex, ()> { if bits_per_dimension * coords.len() > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE { panic!("number of coordinates * bits_per_dimension > sizeof(HilbertIndex) * BITS_PER_BYTE"); } unsafe { return Ok(moore_hilbert_sys::hilbert_c2i( coords.len().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), coords.as_ptr(), )); } } /// Convert an index into a Hilbert curve to a set of coordinates /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits per dimension /// * `index` - The index, contains the number of dimensions * `nBits` bits (so `nDims` * `nBits` must be <= `BITS_PER_BYTE` * sizeof(`HilbertIndex`)). /// * `coords` - The slice where the coordinates will be written /// /// # Assumptions /// /// `number of dimesions` * `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// /// # Example /// /// ``` /// let bits_per_dimension = 8; /// /// // Start by getting an index along the Hilbert curve for this point /// let start_vec = vec![1,2,3]; /// let r = moore_hilbert::coordinates_to_index(bits_per_dimension, &start_vec).unwrap(); /// assert_eq!(r, 36); /// /// // A place to put the coordinates from the Hilbert curve index /// let mut extracted_coords = [0,0,0]; /// moore_hilbert::index_to_coordinates(bits_per_dimension, r, &mut extracted_coords); /// /// /// The coordinates should match. /// assert_eq!(start_vec, extracted_coords); /// /// // increment the index and make sure the coords don't match /// moore_hilbert::index_to_coordinates(bits_per_dimension, r+1, &mut extracted_coords); /// assert_ne!(start_vec, extracted_coords); /// /// ``` pub fn index_to_coordinates( bits_per_dimension: BitsPerDimensionType, index: HilbertIndex, coords: &mut [HilbertCoordinate], ) -> () { if bits_per_dimension as usize * coords.len() > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE { panic!("number of coordinates * bits_per_dimension > mem::size_of(HilbertIndex) * BITS_PER_BYTE"); } unsafe { return moore_hilbert_sys::hilbert_i2c( coords.len().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), index, coords.as_mut_ptr(), ); } } /// Determine which of two points lies further along the Hilbert curve /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits/coordinate. /// * `coord1` - Slice of coordinates /// * `coord2` - Slice of coordinates /// /// # Returns /// /// * Ordering result that indicates the comparison of coord1 and coord2 /// /// # Assumptions /// /// `nBits` <= (sizeof `HilbertIndex`) * `bits_per_byte` /// /// # Example /// /// ``` /// use std::cmp::Ordering; /// let coords = vec![ /// vec![1,2,3], /// vec![1,2,4], /// ]; /// /// let bits_per_dimension = 4; /// /// assert_eq!(moore_hilbert::coordinates_compare(bits_per_dimension, &coords[0], &coords[1]), Ordering::Less); /// assert_eq!(moore_hilbert::coordinates_compare(bits_per_dimension, &coords[0], &coords[0]), Ordering::Equal); /// assert_eq!(moore_hilbert::coordinates_compare(bits_per_dimension, &coords[1], &coords[0]), Ordering::Greater); /// ``` pub fn coordinates_compare( bits_per_dimension: BitsPerDimensionType, coord1: &[HilbertCoordinate], coord2: &[HilbertCoordinate], ) -> Ordering { if bits_per_dimension as usize > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE { panic!("bits_per_dimension > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE"); } if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } unsafe { let r = moore_hilbert_sys::hilbert_cmp( coord1.len().try_into().unwrap(), mem::size_of::<HilbertCoordinate>().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), coord1.as_ptr() as *const std::ffi::c_void, coord2.as_ptr() as *const std::ffi::c_void, ); if r == -1 { return Ordering::Less; } if r == 0 { return Ordering::Equal; } return Ordering::Greater; } } /// Determine which of two points lies further along the Hilbert curve /// /// # Arguments /// /// * `coord1` - Slice of coordinates using floats /// * `coord2` - Slice of coordinates using floats /// /// # Returns /// /// * Ordering result that indicates the comparison of coord1 and coord2 /// /// ``` /// use std::cmp::Ordering; /// let coords = vec![ /// vec![1.0, 2.0, 3.0], /// vec![1.0, 2.0, 4.0], /// ]; /// /// /// assert_eq!(moore_hilbert::coordinates_float_compare(&coords[0], &coords[0]), Ordering::Equal); /// assert_eq!(moore_hilbert::coordinates_float_compare(&coords[0], &coords[1]), Ordering::Greater); /// assert_eq!(moore_hilbert::coordinates_float_compare(&coords[1], &coords[0]), Ordering::Less); /// ``` pub fn coordinates_float_compare(coord1: &[f64], coord2: &[f64]) -> Ordering { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } unsafe { let r = moore_hilbert_sys::hilbert_ieee_cmp( coord1.len().try_into().unwrap(), coord1.as_ptr(), coord2.as_ptr(), ); if r == -1 { return Ordering::Less; } if r == 0 { return Ordering::Equal; } return Ordering::Greater; } } /// Advance from one point to its successor on a Hilbert curve /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits/coordinate. /// * `coord` - Coordinates that will be modified to be the next point on the curve /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// /// # Example /// /// ``` /// let bits_per_dimension = 8; /// let mut coords = vec![2, 2, 5]; /// /// /// Get the initial position along the Hilbert curve /// let first_index = moore_hilbert::coordinates_to_index(bits_per_dimension, &coords).unwrap(); /// /// /// Increment that position /// moore_hilbert::coordinates_increment(bits_per_dimension, &mut coords); /// /// /// Convert the incremented position back to a new index on the Hilbert curve /// let new_index = moore_hilbert::coordinates_to_index(bits_per_dimension, &coords).unwrap(); /// /// /// The newly incremented index should advance along the curve by 1. /// assert_eq!(new_index-first_index, 1); /// /// ``` pub fn coordinates_increment( bits_per_dimension: BitsPerDimensionType, coord: &mut [HilbertCoordinate], ) -> () { if bits_per_dimension as usize > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE { panic!("bits_per_dimension > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE"); } unsafe { moore_hilbert_sys::hilbert_incr( coord.len().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), coord.as_mut_ptr(), ); } } /// Determine the first or last vertex of a box to lie on a Hilbert curve /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits per coordinate /// * `find_min` - Is the least vertex sought? /// * `coord1` - One corner of box /// * `coord2` - Opposite corner /// /// # Returns /// /// `coord1` and `coord2` modified to refer to selected corner /// value returned is log2 of size of largest power-of-two-aligned box that /// contains the selected corner and no other corners /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// pub fn box_vertex( bits_per_dimension: BitsPerDimensionType, find_min: bool, coord1: &mut [HilbertCoordinate], coord2: &mut [HilbertCoordinate], ) -> usize { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } if bits_per_dimension as usize > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE { panic!("bits_per_dimension > mem::size_of::<HilbertIndex>() * BITS_PER_BYTE"); } unsafe { return moore_hilbert_sys::hilbert_box_vtx( coord1.len().try_into().unwrap(), mem::size_of::<HilbertCoordinate>().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), if find_min { 1 } else { 0 }, coord1.as_ptr() as *mut std::ffi::c_void, coord2.as_ptr() as *mut std::ffi::c_void, ) as usize; } } /// Determine the first or last vertex of a box to lie on a Hilbert curve /// /// # Arguments /// /// * `find_min` - Is the least vertex sought? /// * `c1` - One corner of box /// * `c2` - Opposite corner /// /// # Returns /// `c1` and `c2` modified to refer to selected corder /// value returned is log2 of size of largest power-of-two-aligned box that /// contains the selected corner and no other corners /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// pub fn box_float_vertex(find_min: bool, coord1: &mut [f64], coord2: &mut [f64]) -> usize { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } unsafe { return moore_hilbert_sys::hilbert_ieee_box_vtx( coord1.len().try_into().unwrap(), if find_min { 1 } else { 0 }, coord1.as_mut_ptr(), coord2.as_mut_ptr(), ) as usize; } } /// Determine the first or last point of a box to lie on a Hilbert curve /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits/coordinate. /// * `find_min` - Is it the least vertex sought? /// * `coord1` - Coordinates of one corner of box /// * `coord2` - Coordinates of the opposite corner of box /// /// # Returns /// /// `coord1` and `coord2` are modified to refer to the least point /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// /// # Example /// /// ``` /// let bits_per_dimension = 8; /// let starting_corners = vec![ /// vec![0, 0], // smallest coordinate point /// vec![10, 10] // largest coordinate point /// ]; /// /// // Since the coordinates will be overwritten when finding the points of the box /// // make copies. /// /// let mut low_corner_1 = starting_corners[0].clone(); /// let mut high_corner_1 = starting_corners[1].clone(); /// moore_hilbert::box_point(bits_per_dimension, true, &mut low_corner_1, &mut high_corner_1); /// /// // Both points should equal each other after the function call /// assert_eq!(high_corner_1, low_corner_1); /// /// let low_point = low_corner_1.clone(); /// /// // Now get the high point. /// low_corner_1 = starting_corners[0].clone(); /// high_corner_1 = starting_corners[1].clone(); /// moore_hilbert::box_point(bits_per_dimension, false, &mut low_corner_1, &mut high_corner_1); /// /// // Both points should equal each other after the function call /// assert_eq!(high_corner_1, low_corner_1); /// /// let high_point = low_corner_1.clone(); /// /// assert_eq!(low_point, vec![0, 0]); /// assert_eq!(high_point, vec![1, 10]); /// /// ``` pub fn box_point( bits_per_dimension: BitsPerDimensionType, find_min: bool, coord1: &mut [HilbertCoordinate], coord2: &mut [HilbertCoordinate], ) -> usize { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } unsafe { return moore_hilbert_sys::hilbert_box_pt( coord1.len().try_into().unwrap(), mem::size_of::<HilbertCoordinate>().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), if find_min { 1 } else { 0 }, coord1.as_mut_ptr() as *mut std::ffi::c_void, coord2.as_mut_ptr() as *mut std::ffi::c_void, ) as usize; } } /// Determine the first or last point of a box to lie on a Hilbert curve /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits/coordinate. /// * `find_min` - Is it the least vertex sought? /// * `coord1` - Coordinates of one corner of box /// * `coord2` - Coordinates of the opposite corner of box /// /// # Returns /// /// `coord1` and `coord2` are modified to refer to the least point /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// pub fn box_point_float(find_min: bool, coord1: &mut [f64], coord2: &mut [f64]) -> usize { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } unsafe { return moore_hilbert_sys::hilbert_ieee_box_pt( coord1.len().try_into().unwrap(), if find_min { 1 } else { 0 }, coord1.as_mut_ptr(), coord2.as_mut_ptr(), ) as usize; } } /// Determine the first point of a box after a given point to lie on a Hilbert curve. /// /// # Arguments /// /// * `bits_per_dimension` - Number of bits per dimension /// * `find_prev` - Is the previous point sought? /// * `coord1` - Coordinates of one corner of the box /// * `coord2` - Coordinates of the opposite corner of the box /// * `point` - Coordinates which are a lower bound on the point returned /// /// # Returns /// /// If true `coord1` and `coord2` are modified to point to the least point after `point` in the box. /// /// If false the arguments are unchanged and the point is beyond the last point of the box /// /// # Assumptions /// /// `bits_per_dimension` <= (sizeof `HilbertIndex`) * (`bits_per_byte`) /// pub fn box_next_point( bits_per_dimension: BitsPerDimensionType, find_prev: bool, coord1: &mut [HilbertCoordinate], coord2: &mut [HilbertCoordinate], point: &[HilbertCoordinate], ) -> bool { if coord1.len() != coord2.len() { panic!("Coordinates supplied are not equal in length"); } if point.len() != coord1.len() { panic!("Coordinates supplied are not equal in length to the point supplied"); } unsafe { if moore_hilbert_sys::hilbert_nextinbox( coord1.len().try_into().unwrap(), mem::size_of::<HilbertCoordinate>().try_into().unwrap(), bits_per_dimension.try_into().unwrap(), if find_prev { 1 } else { 0 }, coord1.as_mut_ptr() as *mut std::ffi::c_void, coord2.as_mut_ptr() as *mut std::ffi::c_void, point.as_ptr() as *mut std::ffi::c_void, ) == 1 { true } else { false } } }