Skip to content

Commit

Permalink
Merge pull request #158 from schalkdaniel/general_updates
Browse files Browse the repository at this point in the history
update c++ manual
  • Loading branch information
Daniel Schalk committed Mar 31, 2018
2 parents d00a8fd + b782f89 commit 25706cc
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/cpp_man/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<h1><a class="anchor" id="install_sec"></a>
Installation</h1>
<p>Basically, the <code>C++</code> code can be exported and be used within any language. The only restriction is to exclude the <a href="https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-introduction.pdf"><code>Rcpp</code></a> specific parts which includes some <code>Rcpp::Rcout</code> printer and the custom classes which requires <code>Rcpp::Function</code> or external pointer of <code>R</code> as well as the <a href="https://cran.r-project.org/web/packages/RcppArmadillo/vignettes/RcppArmadillo-intro.pdf"><code>RcppArmadillo</code></a> package. To get <a href="http://arma.sourceforge.net"><code>Armadillo</code></a> run independent of <code>Rcpp</code> one has to link the library manually.</p>
<p>As it can already be suspected, the main intend is to use this package within <code>R</code>. This is achived by wrapping the pure <code>C++</code> classes by another <code>C++</code> wrapper which are then exportet as <code>S4</code> class using the <a href="https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf">Rcpp modules</a>. So the easiest way of using <code>compboost</code> is to install the <code>R</code> package:</p>
<p>As it can already be suspected, the main intend is to use this package within <code>R</code>. This is achived by wrapping the pure <code>C++</code> classes by another <code>C++</code> wrapper which are then exported as <code>S4</code> class using the <a href="https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf">Rcpp modules</a>. So the easiest way of using <code>compboost</code> is to install the <code>R</code> package:</p>
<div class="fragment"><div class="line">devtools::install_github(<span class="stringliteral">&quot;schalkdaniel/compboost&quot;</span>)</div></div><!-- fragment --><p>etc... </p>
</div></div><!-- contents -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp_man/latex/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This manual should give an overview about the structure and functionality of the {\ttfamily compboost} {\ttfamily C++} classes. To get an insight into the underlying theory check out the {\ttfamily compboost} vignettes\+:\hypertarget{index_install_sec}{}\section{Installation}\label{index_install_sec}
Basically, the {\ttfamily C++} code can be exported and be used within any language. The only restriction is to exclude the \href{https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-introduction.pdf}{\tt {\ttfamily Rcpp}} specific parts which includes some {\ttfamily Rcpp\+::\+Rcout} printer and the custom classes which requires {\ttfamily Rcpp\+::\+Function} or external pointer of {\ttfamily R} as well as the \href{https://cran.r-project.org/web/packages/RcppArmadillo/vignettes/RcppArmadillo-intro.pdf}{\tt {\ttfamily Rcpp\+Armadillo}} package. To get \href{http://arma.sourceforge.net}{\tt {\ttfamily Armadillo}} run independent of {\ttfamily Rcpp} one has to link the library manually.

As it can already be suspected, the main intend is to use this package within {\ttfamily R}. This is achived by wrapping the pure {\ttfamily C++} classes by another {\ttfamily C++} wrapper which are then exportet as {\ttfamily S4} class using the \href{https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf}{\tt Rcpp modules}. So the easiest way of using {\ttfamily compboost} is to install the {\ttfamily R} package\+:
As it can already be suspected, the main intend is to use this package within {\ttfamily R}. This is achived by wrapping the pure {\ttfamily C++} classes by another {\ttfamily C++} wrapper which are then exported as {\ttfamily S4} class using the \href{https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf}{\tt Rcpp modules}. So the easiest way of using {\ttfamily compboost} is to install the {\ttfamily R} package\+:


\begin{DoxyCode}
Expand Down
2 changes: 1 addition & 1 deletion src/compboost.h
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
*
* As it can already be suspected, the main intend is to use this package
* within `R`. This is achived by wrapping the pure `C++` classes by another
* `C++` wrapper which are then exportet as `S4` class using the
* `C++` wrapper which are then exported as `S4` class using the
* <a href="https://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-modules.pdf">Rcpp
* modules</a>. So the easiest way of using `compboost` is to install the
* `R` package:
Expand Down

0 comments on commit 25706cc

Please sign in to comment.