Skip to content

Commit 8ca05a1

Browse files
committed
document vignette work
1 parent 5a697d4 commit 8ca05a1

File tree

3 files changed

+50
-40
lines changed

3 files changed

+50
-40
lines changed

ChangeLog

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,35 @@
1+
2013-08-31 Dirk Eddelbuettel <edd@debian.org>
2+
3+
* inst/doc/*: Moved all vignettes to vignettes/*
4+
* vignettes/*: Minor updates to some vignettes
5+
16
2013-08-22 Romain Francois <romain@r-enthusiasts.com>
27

3-
* include/Rcpp/traits/is_primitive.h : new trait to identify if a type is
4-
primitive, this is a shortcut of using r_type_traits and compare it
5-
to r_type_primitive_tag
6-
* include/Rcpp/traits/r_type_traits.h : new tag r_type_pair_tag to handle
7-
wrapping map<KEY, VALUE> where KEY can be converted to String and VALUE
8-
can wrap itself
8+
* include/Rcpp/traits/is_primitive.h : new trait to identify if a
9+
type is primitive, this is a shortcut of using r_type_traits and
10+
compare it to r_type_primitive_tag
11+
* include/Rcpp/traits/r_type_traits.h : new tag r_type_pair_tag to
12+
handle wrapping map<KEY, VALUE> where KEY can be converted to String
13+
and VALUE can wrap itself
914
* include/Rcpp/internal/wrap.h : handling map<KEY, VALUE> and vector<T>
1015
where T is a class handled by modules
11-
* include/Rcpp/api/meat/wrap.h : implementations to handle map<KEY, VALUE>
12-
* unitTests/cpp/wrap.cpp : more tests for map<KEY, VALUE> with KEY not a string
13-
* unitTests/runit.wrap.R : more tests for map<KEY, VALUE> with KEY not a string
14-
15-
* include/Rcpp/internal/export.h : added export_range__dispatch for the
16-
r_type_generic_tag tag. Meaning we can now use as< vector<T> > where
17-
T is not a primitive
16+
* include/Rcpp/api/meat/wrap.h : implementations to handle map<KEY,
17+
VALUE>
18+
* unitTests/cpp/wrap.cpp : more tests for map<KEY, VALUE> with KEY
19+
not a string
20+
* unitTests/runit.wrap.R : more tests for map<KEY, VALUE> with KEY
21+
not a string
22+
23+
* include/Rcpp/internal/export.h : added export_range__dispatch for
24+
the r_type_generic_tag tag. Meaning we can now use as< vector<T> >
25+
where T is not a primitive
1826
* include/Rcpp/api/meat/export.h : implementation in meat because it needs as
19-
27+
2028
2013-08-01 Romain Francois <romain@r-enthusiasts.com>
2129

22-
* unitTests/cpp/wstring.cpp: fix to re-enable wstring test suite.
30+
* unitTests/cpp/wstring.cpp: fix to re-enable wstring test suite.
2331
* unitTests/runit.wstring.R: re-enable the wstring test suite.
24-
32+
2533
2013-07-31 Dirk Eddelbuettel <edd@debian.org>
2634

2735
* DESCRIPTION: Bump development version to 0.10.4.3

DESCRIPTION

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Description: The Rcpp package provides R functions as well as a C++ library
5151
see 'citation("Rcpp")' for details.
5252
Depends: R (>= 2.15.1)
5353
Imports: methods
54-
Suggests: RUnit, inline, rbenchmark
54+
Suggests: RUnit, inline, rbenchmark, highlight
55+
VignetteBuilder: highlight
5556
URL: http://www.rcpp.org, http://dirk.eddelbuettel.com/code/rcpp.html, http://blog.r-enthusiasts.com/tag/rcpp/
5657
License: GPL (>= 2)
5758
BugReports: http://r-forge.r-project.org/tracker/?atid=637&group_id=155&func=browse
58-
MailingList: Please send questions and comments regarding Rcpp to rcpp-devel@lists.r-forge.r-project.org
59-
59+
MailingList: Please send questions and comments regarding Rcpp to rcpp-devel@lists.r-forge.r-project.or

inst/NEWS.Rd

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
\section{Changes in Rcpp version 0.10.5 (future)}{
66
\itemize{
7-
87
\item Changes in Rcpp API:
98
\itemize{
109
\item Add \code{#defined(__sun)} to lists of operating systems to
@@ -24,10 +23,10 @@
2423
\code{String} and \code{VALUE} is either a primitive type (int, double)
2524
or a type that wraps. Examples :
2625
\itemize{
27-
\item \code{std::map<int, double>} : we can make a String from an int,
28-
and double is primitive
29-
\item \code{boost::unordered_map<double, std::vector<double> >}: we can make
30-
a String from a double and \code{std::vector<double>} can wrap itself
26+
\item \code{std::map<int, double>} : we can make a String from an int,
27+
and double is primitive
28+
\item \code{boost::unordered_map<double, std::vector<double> >}: we can make
29+
a String from a double and \code{std::vector<double>} can wrap itself
3130
}
3231
Other examples of this are included at the end of the \code{wrap} unit test
3332
file (\code{runit.wrap.R} and \code{wrap.cpp}).
@@ -36,34 +35,37 @@
3635
\code{vector<Foo>}, ... An example is included in the \code{wrap} unit test
3736
file
3837
}
39-
4038
\item Changes in Attributes:
4139
\itemize{
42-
\item Objects exported by a module (i.e. by a \code{RCPP_MODULE} call
43-
in a file that is processed by \code{sourceCpp}) are now directly
44-
available in the environment. We used to make the module object
45-
available, which was less useful.
46-
\item A plugin for 'openmp' has been added to support use of OpenMP.
47-
\item \code{Rcpp::export} now takes advantage of the more flexible
48-
\code{as<>}, handling constness and referenceness of the input types.
49-
For users, it means that for the parameters of function exported by modules,
50-
we can now use references, pointers and const versions of them.
51-
The Module.cpp file has an example.
40+
\item Objects exported by a module (i.e. by a \code{RCPP_MODULE} call
41+
in a file that is processed by \code{sourceCpp}) are now directly
42+
available in the environment. We used to make the module object
43+
available, which was less useful.
44+
\item A plugin for \code{openmp} has been added to support use of OpenMP.
45+
\item \code{Rcpp::export} now takes advantage of the more flexible
46+
\code{as<>}, handling constness and referenceness of the input types.
47+
For users, it means that for the parameters of function exported by modules,
48+
we can now use references, pointers and const versions of them.
49+
The file \code{Module.cpp} file has an example.
5250
}
53-
5451
\item Changes in Modules:
5552
\itemize{
5653
\item We can now expose functions and methods that take
5754
\code{T&} or \code{const T&} as arguments. In these situations
5855
objects are no longer copied as they used to be.
5956
}
60-
6157
\item Changes in sugar:
6258
\itemize{
63-
\item \code{is_na} supports classes \code{DatetimeVector} and
64-
\code{DateVector}
59+
\item \code{is_na} supports classes \code{DatetimeVector} and
60+
\code{DateVector}
61+
}
62+
\item Changes in Rcpp documentation:
63+
\itemize{
64+
\item The vignettes have been moved from \code{inst/doc/} to the
65+
\code{vignettes} directory which is now preferred
66+
\item The unitTest vignette has been disabled as no longer builds
67+
when called from \code{R CMD check};
6568
}
66-
6769
\item Deprecation of \code{RCPP_FUNCTION_*}:
6870
\itemize{
6971
\item The macros from the \code{preprocessor_generated.h} file

0 commit comments

Comments
 (0)