-
Notifications
You must be signed in to change notification settings - Fork 25
/
number_of_zones.R
73 lines (67 loc) · 1.46 KB
/
number_of_zones.R
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
#' @include internal.R
NULL
#' Number of zones
#'
#' Extract the number of zones in an object.
#'
#' @param x [problem()], [optimization_problem()], or [zones()] object.
#'
#' @param ... not used.
#'
#' @return An `integer` number of zones.
#'
#' @examples
#' \dontrun{
#' # load data
#' sim_zones_pu_raster <- get_sim_zones_pu_raster()
#' sim_zones_features <- get_sim_zones_features()
#'
#' # print number of zones in a Zones object
#' print(number_of_zones(sim_zones_features))
#
#' # create problem with multiple zones
#' p <-
#' problem(sim_zones_pu_raster, sim_zones_features) %>%
#' add_min_set_objective() %>%
#' add_relative_targets(matrix(0.2, ncol = 3, nrow = 5)) %>%
#' add_binary_decisions()
#'
#' # print number of zones in the problem
#' print(number_of_zones(p))
#' }
#' @export
number_of_zones <- function(x, ...) {
assert_required(x)
rlang::check_dots_empty()
UseMethod("number_of_zones")
}
#' @rdname number_of_zones
#'
#' @export
number_of_zones.ConservationProblem <- function(x, ...) {
x$number_of_zones()
}
#' @rdname number_of_zones
#'
#' @export
number_of_zones.OptimizationProblem <- function(x, ...) {
x$number_of_zones()
}
#' @rdname number_of_zones
#'
#' @export
number_of_zones.ZonesRaster <- function(x, ...) {
length(x)
}
#' @rdname number_of_zones
#'
#' @export
number_of_zones.ZonesSpatRaster <- function(x, ...) {
length(x)
}
#' @rdname number_of_zones
#'
#' @export
number_of_zones.ZonesCharacter <- function(x, ...) {
length(x)
}