RObject -- R object

Usage:

RObject x
Inputs:
- x, a thing, a Macaulay2 object;
Outputs:
- a R object, the R equivalent of x;

Description

An RObject is a SEXP (pointer) to an R object in memory. Note that in R, most objects are actually vectors, and scalars are just vectors of length 1.

RObject is a SelfInitializingType, and so it acts as its own constructor method. When passed a Macaulay2 object as input, the corresponding R object is returned. See the converting to R objects section below for the supported input types.

Each RObject is displayed by calling R's capture.output function.

i1 : RObject {2, 4, 6, 8}

--error or time limit reached in conversion of output to net: type 'debugError()' to run it again; will try conversion to string

o1 = 2, 4, 6, 8

o1 : RObject of type integer

i2 : RObject pi

--error or time limit reached in conversion of output to net: type 'debugError()' to run it again; will try conversion to string

o2 = 3.14159265358979

o2 : RObject of type double

It is converted to a string using R's toString function.

i3 : toString RObject {2, 4, 6, 8}

o3 = 2, 4, 6, 8

new RObject from Boolean -- create an R logical vector from a Boolean
new RObject from CC -- create an R complex vector from a complex number
new RObject from HashTable -- create an R environment from a hash table
new RObject from List -- create an R vector from a list
new RObject from Matrix -- create an R matrix from a Macaulay2 matrix
new RObject from Nothing -- create an R NULL object
new RObject from RR -- create an R double vector from a real or rational number
new RObject from Sequence -- create an R pairlist from a sequence
new RObject from String -- create an R character vector from a string
new RObject from Symbol -- create an R character vector from a symbol
new RObject from ZZ -- create an R integer vector from an integer
NA -- missing value

converting from R objects

value(RObject) -- convert R object to Macaulay2

extracting or replacing parts

RObject _ Thing -- extract a single element of an R object
RObject Array -- extract multiple elements of an R object

iteration

iterator(RObject) -- iterate through an R object
length(RObject) -- the length of an R object

arithmetic operators

RObject + RObject -- add R objects
RObject - RObject -- subtract R objects
RObject * RObject -- multiply R objects
RObject / RObject -- divide R objects
RObject ^ RObject -- exponentiation of R objects
RObject % RObject -- modulo of R objects
RObject // RObject -- floor division of R objects
RObject : RObject -- R colon operator

relational operators

RObject == RObject -- equality of R objects
RObject ? RObject -- comparison of R objects

logical operators

not RObject -- logical negation of an R object
RObject and RObject -- logical conjunction of R objects
RObject or RObject -- logical disjunction of R objects
RObject xor RObject -- logical exclusive disjunction of R objects

bitwise operators

~ RObject -- bitwise NOT of an R object, or create a one-sided formula
RObject & RObject -- bitwise AND of R objects
RObject | RObject -- bitwise OR of R objects
RObject ^^ RObject -- bitwise XOR of R objects
RObject << RObject -- bitwise left shift of an R object
RObject >> RObject -- bitwise right shift of an R object

rounding

ceiling(RObject) -- ceiling of an R object
floor(RObject) -- floor of an R object
truncate(RObject) -- truncation of an R object
round(RObject,RObject) -- rounding of an R object

maxima, minima, sums, and products

max(RObject) -- maximum of an R object
min(RObject) -- minimum of an R object
sum(RObject) -- sum of elements of an R object
product(RObject) -- product of elements of an R object

power, exponential, and logarithmic functions

abs(RObject) -- absolute value of an R object
sqrt(RObject) -- square root of an R object
exp(RObject) -- exponential of an R object
expm1(RObject) -- exponential minus 1 of an R object
log(RObject) -- natural logarithm of an R object
log1p(RObject) -- natural logarithm of 1 plus an R object

trigonometric functions

acos(RObject) -- arccosine of an R object
asin(RObject) -- arcsine of an R object
atan(RObject) -- arctangent of an R object
atan2(RObject,RObject) -- two-argument arctangent of R objects
cos(RObject) -- cosine of an R object
sin(RObject) -- sine of an R object
tan(RObject) -- tangent of an R object

hyperbolic functions

acosh(RObject) -- hyperbolic arccosine of an R object
asinh(RObject) -- hyperbolic arcsine of an R object
atanh(RObject) -- hyperbolic arctangent of an R object
cosh(RObject) -- hyperbolic cosine of an R object
sinh(RObject) -- hyperbolic sine of an R object
tanh(RObject) -- hyperbolic tangent of an R object

complex number functions

conjugate(RObject) -- complex conjugate of an R object
imaginaryPart(RObject) -- imaginary part of an R object
realPart(RObject) -- real part of an R object

special mathematical functions

Beta(RObject,RObject) -- beta function of R objects
Digamma(RObject) -- digamma function of an R object
Gamma(RObject) -- gamma function of an R object
lngamma(RObject) -- log-gamma function of an R object
binomial(RObject,RObject) -- binomial coefficient of R objects
RObject ! -- factorial of an R object

formulas

RObject ~ RObject -- create a two-sided R formula

Methods that use a R object:

~ RObject -- bitwise NOT of an R object, or create a one-sided formula
abs(RObject) -- absolute value of an R object
acos(RObject) -- arccosine of an R object
acosh(RObject) -- hyperbolic arccosine of an R object
asin(RObject) -- arcsine of an R object
asinh(RObject) -- hyperbolic arcsine of an R object
atan(RObject) -- arctangent of an R object
atan2(RObject,RObject) -- two-argument arctangent of R objects
atan2(RObject,Thing) -- see atan2(RObject,RObject) -- two-argument arctangent of R objects
atan2(Thing,RObject) -- see atan2(RObject,RObject) -- two-argument arctangent of R objects
atanh(RObject) -- hyperbolic arctangent of an R object
Beta(RObject,RObject) -- beta function of R objects
Beta(RObject,Thing) -- see Beta(RObject,RObject) -- beta function of R objects
Beta(Thing,RObject) -- see Beta(RObject,RObject) -- beta function of R objects
binomial(RObject,RObject) -- binomial coefficient of R objects
binomial(RObject,Thing) -- see binomial(RObject,RObject) -- binomial coefficient of R objects
binomial(Thing,RObject) -- see binomial(RObject,RObject) -- binomial coefficient of R objects
ceiling(RObject) -- ceiling of an R object
conjugate(RObject) -- complex conjugate of an R object
cos(RObject) -- cosine of an R object
cosh(RObject) -- hyperbolic cosine of an R object
Digamma(RObject) -- digamma function of an R object
exp(RObject) -- exponential of an R object
expm1(RObject) -- exponential minus 1 of an R object
floor(RObject) -- floor of an R object
Gamma(RObject) -- gamma function of an R object
imaginaryPart(RObject) -- imaginary part of an R object
iterator(RObject) -- iterate through an R object
length(RObject) -- the length of an R object
listSymbols(RObject) -- list symbols in an R environment
lngamma(RObject) -- log-gamma function of an R object
log(RObject) -- natural logarithm of an R object
log1p(RObject) -- natural logarithm of 1 plus an R object
max(RObject) -- maximum of an R object
min(RObject) -- minimum of an R object
new RObject from Boolean -- create an R logical vector from a Boolean
new RObject from CC -- create an R complex vector from a complex number
new RObject from HashTable -- create an R environment from a hash table
new RObject from List -- create an R vector from a list
new RObject from Matrix -- create an R matrix from a Macaulay2 matrix
?? RObject -- see new RObject from Nothing -- create an R NULL object
new RObject from Nothing -- create an R NULL object
new RObject from Number -- see new RObject from RR -- create an R double vector from a real or rational number
new RObject from RR -- create an R double vector from a real or rational number
new RObject from Sequence -- create an R pairlist from a sequence
new RObject from String -- create an R character vector from a string
new RObject from Symbol -- create an R character vector from a symbol
new RObject from ZZ -- create an R integer vector from an integer
not RObject -- logical negation of an R object
product(RObject) -- product of elements of an R object
realPart(RObject) -- real part of an R object
new RFunction from RObject -- see RFunction -- R function
net(RObject)
toString(RObject)
RObject ! -- factorial of an R object
RObject % RObject -- modulo of R objects
RObject % Thing -- see RObject % RObject -- modulo of R objects
Thing % RObject -- see RObject % RObject -- modulo of R objects
RObject & RObject -- bitwise AND of R objects
RObject & Thing -- see RObject & RObject -- bitwise AND of R objects
Thing & RObject -- see RObject & RObject -- bitwise AND of R objects
RObject * RObject -- multiply R objects
RObject * Thing -- see RObject * RObject -- multiply R objects
Thing * RObject -- see RObject * RObject -- multiply R objects
+ RObject -- see RObject + RObject -- add R objects
RObject + RObject -- add R objects
RObject + Thing -- see RObject + RObject -- add R objects
Thing + RObject -- see RObject + RObject -- add R objects
- RObject -- see RObject - RObject -- subtract R objects
RObject - RObject -- subtract R objects
RObject - Thing -- see RObject - RObject -- subtract R objects
Thing - RObject -- see RObject - RObject -- subtract R objects
RObject / RObject -- divide R objects
RObject / Thing -- see RObject / RObject -- divide R objects
Thing / RObject -- see RObject / RObject -- divide R objects
RObject // RObject -- floor division of R objects
RObject // Thing -- see RObject // RObject -- floor division of R objects
Thing // RObject -- see RObject // RObject -- floor division of R objects
RObject .. RObject -- see RObject : RObject -- R colon operator
RObject .. Thing -- see RObject : RObject -- R colon operator
RObject : RObject -- R colon operator
RObject : Thing -- see RObject : RObject -- R colon operator
Thing .. RObject -- see RObject : RObject -- R colon operator
Thing : RObject -- see RObject : RObject -- R colon operator
RObject << RObject -- bitwise left shift of an R object
RObject << Thing -- see RObject << RObject -- bitwise left shift of an R object
Thing << RObject -- see RObject << RObject -- bitwise left shift of an R object
RObject == RObject -- equality of R objects
RObject == Thing -- see RObject == RObject -- equality of R objects
Thing == RObject -- see RObject == RObject -- equality of R objects
RObject >> RObject -- bitwise right shift of an R object
RObject >> Thing -- see RObject >> RObject -- bitwise right shift of an R object
Thing >> RObject -- see RObject >> RObject -- bitwise right shift of an R object
RObject ? RObject -- comparison of R objects
RObject ? Thing -- see RObject ? RObject -- comparison of R objects
Thing ? RObject -- see RObject ? RObject -- comparison of R objects
RObject ^ RObject -- exponentiation of R objects
RObject ^ Thing -- see RObject ^ RObject -- exponentiation of R objects
Thing ^ RObject -- see RObject ^ RObject -- exponentiation of R objects
RObject ^^ RObject -- bitwise XOR of R objects
RObject ^^ Thing -- see RObject ^^ RObject -- bitwise XOR of R objects
Thing ^^ RObject -- see RObject ^^ RObject -- bitwise XOR of R objects
RObject _ Thing -- extract a single element of an R object
RObject _ Thing = Thing -- replace a single element of an R object
RObject | RObject -- bitwise OR of R objects
RObject | Thing -- see RObject | RObject -- bitwise OR of R objects
Thing | RObject -- see RObject | RObject -- bitwise OR of R objects
RObject ~ RObject -- create a two-sided R formula
RObject ~ Thing -- see RObject ~ RObject -- create a two-sided R formula
Thing ~ RObject -- see RObject ~ RObject -- create a two-sided R formula
RObject and RObject -- logical conjunction of R objects
RObject and Thing -- see RObject and RObject -- logical conjunction of R objects
Thing and RObject -- see RObject and RObject -- logical conjunction of R objects
RObject Array -- extract multiple elements of an R object
RObject or RObject -- logical disjunction of R objects
RObject or Thing -- see RObject or RObject -- logical disjunction of R objects
Thing or RObject -- see RObject or RObject -- logical disjunction of R objects
RObject SPACE Array = Thing -- replace multiple elements of an R object
RObject xor RObject -- logical exclusive disjunction of R objects
RObject xor Thing -- see RObject xor RObject -- logical exclusive disjunction of R objects
Thing xor RObject -- see RObject xor RObject -- logical exclusive disjunction of R objects
round(RObject) -- see round(RObject,RObject) -- rounding of an R object
round(RObject,RObject) -- rounding of an R object
round(RObject,Thing) -- see round(RObject,RObject) -- rounding of an R object
round(Thing,RObject) -- see round(RObject,RObject) -- rounding of an R object
sin(RObject) -- sine of an R object
sinh(RObject) -- hyperbolic sine of an R object
sqrt(RObject) -- square root of an R object
sum(RObject) -- sum of elements of an R object
tan(RObject) -- tangent of an R object
tanh(RObject) -- hyperbolic tangent of an R object
truncate(RObject) -- truncation of an R object
value(RObject) -- convert R object to Macaulay2

For the programmer

The object RObject is a self initializing type, with ancestor classes voidstar < ForeignObject < HashTable < Thing.

The source of this document is in RInterface/doc/objects.m2:127:0.