You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: R/get_distance_pair.R
+26-4Lines changed: 26 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@
3
3
#' @param Graph An object generated by cppRouting::makegraph() function.
4
4
#' @param from A vector of one or more vertices from which distances are calculated (origin).
5
5
#' @param to A vector of one or more vertices (destination).
6
-
#' @param algorithm character. "Dijkstra" for uni-directional Dijkstra, "bi" for bi-directional Dijkstra or "A*".Default to "Dijkstra"
6
+
#' @param algorithm character. "Dijkstra" for uni-directional Dijkstra, "bi" for bi-directional Dijkstra, "A*" or "NBA" for New bi-directional A star .Default to "Dijkstra"
7
7
#' @param constant numeric. Constant to maintain the heuristic function admissible in A* algorithm.
8
8
#' Default to 1, when cost is expressed in the same unit than coordinates. See details
9
9
#' @param allcores Logical. If TRUE, all cores are used.
10
10
#' @return Vector of shortest distances.
11
11
#' @note 'from' and 'to' must be the same length.
12
12
#' @details To perform A*, projected coordinates should be provided in the Graph object.
13
-
#' In A* algorithm, euclidean distance is used as heuristic function.
13
+
#' In A* algorithms, euclidean distance is used as heuristic function.
14
14
#' To understand how A star algorithm work, see https://en.wikipedia.org/wiki/A*_search_algorithm .
15
15
#' To understand the importance of constant parameter, see the package description : https://github.com/vlarmet/cppRouting
Copy file name to clipboardExpand all lines: R/get_path_pair.R
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@
3
3
#' @param Graph An object generated by cppRouting::makegraph() function.
4
4
#' @param from A vector of one or more vertices from which shortest paths are calculated (origin).
5
5
#' @param to A vector of one or more vertices (destination).
6
-
#' @param algorithm character. "Dijkstra" for uni-directional Dijkstra, "bi" for bi-directional Dijkstra or "A*".Default to "Dijkstra"
6
+
#' @param algorithm character. "Dijkstra" for uni-directional Dijkstra, "bi" for bi-directional Dijkstra, "A*" or "NBA" for New bi-directional A star .Default to "Dijkstra"
7
7
#' @param constant numeric. Constant to maintain the heuristic function admissible in A* algorithm.
8
8
#'Default to 1, when cost is expressed in the same unit than coordinates. See details
9
9
#' @return List containing shortest path between from and to.
10
10
#' @note 'from' and 'to' must be the same length.
11
11
#' @details To perform A*, projected coordinates should be provided in the Graph object.
12
-
#' In A* algorithm, euclidean distance is used as heuristic function.
12
+
#' In A* algorithms, euclidean distance is used as heuristic function.
13
13
#' To understand how A star algorithm work, see https://en.wikipedia.org/wiki/A*_search_algorithm .
14
14
#' To understand the importance of constant parameter, see the package description : https://github.com/vlarmet/cppRouting .
0 commit comments