Add armadillo_version_typed() helper

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,11 @@
+2025-10-17  Dirk Eddelbuettel  <[email protected]>
+
+	* src/RcppArmadillo.cpp (armadillo_version_typed): Added
+	* man/armadillo_version.Rd: Documentation added
+	* src/RcppExports.cpp: Regenerated
+	* R/RcppExports.R: Idem
+	* NAMESPACE: Exported
+
 2025-10-16  Dirk Eddelbuettel  <[email protected]>
 
 	* DESCRIPTION (Version, Date): RcppArmadillo 15.1.99-1

NAMESPACE

@@ -9,6 +9,7 @@ export("fastLmPure",
        "fastLm",
        "RcppArmadillo.package.skeleton",
        "armadillo_version",
+       "armadillo_version_typed",
        "armadillo_set_seed",
        "armadillo_set_seed_random",
 

R/RcppExports.R

@@ -8,12 +8,19 @@
 #' or a named vector with three elements \code{major}, \code{minor} and \code{patch}.
 #' @return Depending on the value of \code{single}, either a single number describing
 #' the Armadillo version or a named vector with three elements \code{major}, \code{minor}
-#' and \code{patch}.
+#' and \code{patch}. The function \code{armadillo_version_typed} returns an S3 object
+#' of classes \sQuote{package_version} and \sQuote{numeric_version} which offer comparison
+#' and formatting operators.
 #' @seealso Armadillo header file \code{arma_version.hpp}.
 armadillo_version <- function(single) {
     .Call(`_RcppArmadillo_armadillo_version`, single)
 }
 
+#' @rdname armadillo_version
+armadillo_version_typed <- function() {
+    .Call(`_RcppArmadillo_armadillo_version_typed`)
+}
+
 #' @rdname armadillo_set_seed
 armadillo_set_seed_random <- function() {
     invisible(.Call(`_RcppArmadillo_armadillo_set_seed_random`))

man/armadillo_version.Rd

@@ -27,7 +27,9 @@
 //' or a named vector with three elements \code{major}, \code{minor} and \code{patch}.
 //' @return Depending on the value of \code{single}, either a single number describing
 //' the Armadillo version or a named vector with three elements \code{major}, \code{minor}
-//' and \code{patch}.
+//' and \code{patch}. The function \code{armadillo_version_typed} returns an S3 object
+//' of classes \sQuote{package_version} and \sQuote{numeric_version} which offer comparison
+//' and formatting operators.
 //' @seealso Armadillo header file \code{arma_version.hpp}.
 // [[Rcpp::export]]
 Rcpp::IntegerVector armadillo_version(bool single) {
@@ -47,6 +49,18 @@ Rcpp::IntegerVector armadillo_version(bool single) {
     }
 }
 
+//' @rdname armadillo_version
+// [[Rcpp::export]]
+Rcpp::List armadillo_version_typed() {
+    // create a vector of major, minor, patch
+    auto ver = Rcpp::IntegerVector::create(ARMA_VERSION_MAJOR, ARMA_VERSION_MINOR, ARMA_VERSION_PATCH);
+    // and place it in a list (as e.g. packageVersion() in R returns)
+    auto lst = Rcpp::List::create(ver);
+    // and class it as 'package_version' accessing print() etc methods
+    lst.attr("class") = Rcpp::CharacterVector::create("package_version", "numeric_version");
+    return lst;
+}
+
 // Per request of Gábor Csárdi in https://github.com/RcppCore/RcppArmadillo/issues/11
 //
 //' @rdname armadillo_set_seed

src/RcppArmadillo.cpp

@@ -22,6 +22,16 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// armadillo_version_typed
+Rcpp::List armadillo_version_typed();
+RcppExport SEXP _RcppArmadillo_armadillo_version_typed() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(armadillo_version_typed());
+    return rcpp_result_gen;
+END_RCPP
+}
 // armadillo_set_seed_random
 void armadillo_set_seed_random();
 RcppExport SEXP _RcppArmadillo_armadillo_set_seed_random() {
@@ -76,6 +86,7 @@ END_RCPP
 
 static const R_CallMethodDef CallEntries[] = {
     {"_RcppArmadillo_armadillo_version", (DL_FUNC) &_RcppArmadillo_armadillo_version, 1},
+    {"_RcppArmadillo_armadillo_version_typed", (DL_FUNC) &_RcppArmadillo_armadillo_version_typed, 0},
     {"_RcppArmadillo_armadillo_set_seed_random", (DL_FUNC) &_RcppArmadillo_armadillo_set_seed_random, 0},
     {"_RcppArmadillo_armadillo_set_seed", (DL_FUNC) &_RcppArmadillo_armadillo_set_seed, 1},
     {"_RcppArmadillo_armadillo_get_number_of_omp_threads", (DL_FUNC) &_RcppArmadillo_armadillo_get_number_of_omp_threads, 0},