Skip to content

Commit

Permalink
add reference to DESCRIPTION and function documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lschneiderbauer committed Dec 5, 2023
1 parent 8b36a25 commit fb03e05
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 2 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Package: binpackr
Title: Fast 1d Bin Packing
Version: 0.1.0
Version: 0.1.1
Authors@R:
person("Lukas", "Schneiderbauer", email = "[email protected]", role = c("aut", "cre", "cph"))
Description: Implements the First Fit Decreasing algorithm to achieve one dimensional heuristic bin packing. Runtime is of order O(n log(n)) where n is the number of items to pack.
Description: Implements the First Fit Decreasing algorithm to achieve one dimensional heuristic bin packing. Runtime is of order O(n log(n)) where n is the number of items to pack. See "The Art of Computer Programming Vol. 1" by Donald E. Knuth (1997, ISBN: 0201896834) for more details.
License: GPL (>= 3)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Expand Down
4 changes: 4 additions & 0 deletions R/bin_pack.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
#' @returns A integer vector of labels of the same length as `x`. The integer
#' label at position `i` determines the assignment of the `i`th item
#' with size `x[i]` to a bin.
#' @details See [Wikipedia](https://en.wikipedia.org/wiki/First-fit_bin_packing)
#' for a concise introduction or
#' "The Art of Computer Programming Vol. 1" by Donald E. Knuth
#' (1997, ISBN: 0201896834) for more details.
#' @examples
#' # Generate a vector of item sizes
#' x <- sample(100, 1000, replace = TRUE)
Expand Down
8 changes: 8 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
## Resubmission

This is a resubmission. In this version I have

* added a reference to the description field in the DESCRIPTION file.

* added the same reference to the function documentation.

## R CMD check results

0 errors | 0 warnings | 1 note
Expand Down
6 changes: 6 additions & 0 deletions man/bin_pack_ffd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fb03e05

Please sign in to comment.