R/RcppExports.R

In Rexamine/DataStructures: Useful Data Structures and Algorithms

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' @rdname queue
#' @details
#' \code{as.list.Queue} converts a given queue object to an R list.
#'
#' @return
#' \code{as.list.Queue} returns an R list object.
#' @param queue a queue object
as.list.Queue <- function(queue) {
    .Call('_DataStructures_queue_as_list', PACKAGE = 'DataStructures', queue)
}

#' @rdname queue
#' @details
#' \code{queue_create} creates a new queue.
#'
#' @return
#' \code{queue_create} returns a new, empty queue.
queue_create <- function() {
    .Call('_DataStructures_queue_create', PACKAGE = 'DataStructures')
}

#' @rdname queue
#' @details
#' \code{queue_empty} determines if a given queue is empty or not.
#'
#' @return
#' \code{queue_empty} returns a single logical value.
queue_empty <- function(queue) {
    .Call('_DataStructures_queue_empty', PACKAGE = 'DataStructures', queue)
}

#' @rdname queue
#' @details
#' \code{queue_push} pushes a given object to the back of the queue.
#'
#' @return
#' \code{queue_push} does not return anything interesting.
#'
#' @param obj an R object
queue_push <- function(queue, obj) {
    invisible(.Call('_DataStructures_queue_push', PACKAGE = 'DataStructures', queue, obj))
}

#' @rdname queue
#' @details
#' \code{queue_pop} pops an object from the top of the queue.
#'
#' @return
#' \code{queue_pop} returns an object at the top of te queue or
#' throws an error if the stack is empty.
queue_pop <- function(queue) {
    .Call('_DataStructures_queue_pop', PACKAGE = 'DataStructures', queue)
}

#' @rdname stack
#' @details
#' \code{stack_create} creates a new stack.
#'
#' @return
#' \code{stack_create} returns a new, empty stack.
stack_create <- function() {
    .Call('_DataStructures_stack_create', PACKAGE = 'DataStructures')
}

#' @rdname stack
#' @details
#' \code{as.list.Stack} converts a given stack object to an R list.
#'
#' @return
#' \code{as.list.Stack} returns an R list object.
#'
#' @param stack a stack object
as.list.Stack <- function(stack) {
    .Call('_DataStructures_stack_as_list', PACKAGE = 'DataStructures', stack)
}

#' @rdname stack
#' @details
#' \code{stack_empty} determines if a given stack is empty or not.
#'
#' @return
#' \code{stack_empty} returns a single logical value.
stack_empty <- function(stack) {
    .Call('_DataStructures_stack_empty', PACKAGE = 'DataStructures', stack)
}

#' @rdname stack
#' @details
#' \code{stack_push} pushes a given object to the top of the stack.
#'
#' @return
#' \code{stack_push} does not return anything interesting.
#'
#' @param obj an R object
stack_push <- function(stack, obj) {
    invisible(.Call('_DataStructures_stack_push', PACKAGE = 'DataStructures', stack, obj))
}

#' @rdname stack
#' @details
#' \code{stack_pop} pops an object from the top of the stack.
#'
#' @return
#' \code{stack_pop} returns an object at the top of te stack or
#' throws an error if the stack is empty.
stack_pop <- function(stack) {
    .Call('_DataStructures_stack_pop', PACKAGE = 'DataStructures', stack)
}

#' @rdname vector
#' @details
#' \code{as.list.Vector} converts a given vector object to an R list.
#'
#' @return
#' \code{as.list.Vector} returns an R list object.
#'
#' @param vec a vector object
as.list.Vector <- function(vec) {
    .Call('_DataStructures_vector_as_list', PACKAGE = 'DataStructures', vec)
}

#' @rdname vector
#' @details
#' \code{vector_create} creates a new vector.
#'
#' @return
#' \code{vector_create} returns a new, empty vector.
#'
#' @param n vector size
vector_create <- function(n = 0L) {
    .Call('_DataStructures_vector_create', PACKAGE = 'DataStructures', n)
}

#' @rdname vector
#' @details
#' \code{vector_empty} determines if a given stack is empty or not.
#'
#' @return
#' \code{vector_empty} returns a single logical value.
vector_empty <- function(vec) {
    .Call('_DataStructures_vector_empty', PACKAGE = 'DataStructures', vec)
}

#' @rdname vector
#' @details
#' \code{vector_size} returns a size of vector.
#'
#' @return
#' \code{vector_size} returns a single integer value.
vector_size <- function(vec) {
    .Call('_DataStructures_vector_size', PACKAGE = 'DataStructures', vec)
}

#' @rdname vector
#' @details
#' \code{vector_front} returns the first object of a given vector.
#'
#' @return
#' \code{vector_front} returns a single RObject value or
#' throws an error if a vector is empty.
vector_front <- function(vec) {
    .Call('_DataStructures_vector_front', PACKAGE = 'DataStructures', vec)
}

#' @rdname vector
#' @details
#' \code{vector_back} returns the last object of a given vector.
#'
#' @return
#' \code{vector_back} returns a single RObject value or
#' throws an error if a vector is empty.
vector_back <- function(vec) {
    .Call('_DataStructures_vector_back', PACKAGE = 'DataStructures', vec)
}

#' @rdname vector
#' @details
#' \code{vector_push_back} pushes a given object at the end of the vector.
#'
#' @return
#' \code{vector_push_back} does not return anything interesting.
#'
#' @param obj an R object
vector_push_back <- function(vec, obj) {
    invisible(.Call('_DataStructures_vector_push_back', PACKAGE = 'DataStructures', vec, obj))
}

#' @rdname vector
#' @details
#' \code{vector_pop_back} removes the last element in the vector, effectively
#' reducing the container size by one.
#'
#' @return
#' \code{vector_pop_back} does not return anything interesting. Throws an
#' error if a vector is empty.
vector_pop_back <- function(vec) {
    invisible(.Call('_DataStructures_vector_pop_back', PACKAGE = 'DataStructures', vec))
}

#' @rdname vector
#' @details
#' \code{vector_at} returns an object at position i in the vector.
#'
#' @return
#' \code{vector_at} returns a single RObject value.
vector_at <- function(vec, i) {
    .Call('_DataStructures_vector_at', PACKAGE = 'DataStructures', vec, i)
}

#' @rdname vector
#' @details
#' \code{vector_set_at} sets an object obj at position i in the vector.
#'
#' @return
#' \code{vector_set_at} does not return anything interesting.
#'
#' @param i position in the vector
vector_set_at <- function(vec, i, obj) {
    invisible(.Call('_DataStructures_vector_set_at', PACKAGE = 'DataStructures', vec, i, obj))
}