com-croftsoft-core 0.14.0

A core library of highly reusable code
Documentation 
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

// =============================================================================
//! - Traits for the A* algorithm
//!
//! # Metadata
//! - Copyright: © 2002 - 2022 [`CroftSoft Inc`]
//! - Author: [`David Wallace Croft`]
//! - Rust version: 2022-11-10
//! - Rust since: 2022-10-21
//! - Java version: 2003-04-29
//! - Java since: 2002-04-21
//!
//! # History
//! - Adapted from the interfaces in the Java-based [`CroftSoft Core Library`]
//!   - com.croftsoft.core.ai.astar.Cartographer
//!   - com.croftsoft.core.ai.astar.SpaceTester
//!
//! [`CroftSoft Core Library`]: https://www.croftsoft.com/library/code/
//! [`CroftSoft Inc`]: https://www.croftsoft.com/
//! [`David Wallace Croft`]: https://www.croftsoft.com/people/david/
// =============================================================================

/// An A* algorithm map maker
pub trait Cartographer<N> {
  fn estimate_cost_to_goal(
    &self,
    node: &N,
  ) -> f64;

  fn get_adjacent_nodes(
    &self,
    node: &N,
  ) -> Vec<N>;

  fn get_cost_to_adjacent_node(
    &self,
    from_node: &N,
    to_node: &N,
  ) -> f64;

  fn is_goal_node(
    &self,
    node: &N,
  ) -> bool;
}