fame (version 1.13)

is.scalar: Check for (Fame or Numeric) Scalar or Time Index Series

Description

is.scalar checks whether or not its input is a single, finite number.

isFameScalar checks whether or not its argument could be a 'scalar' in FAME parlance, i.e., if it is an atomic object of length one and not a time series or time indexed series. ti objects of length one are what FAME calls a 'date', other scalars are strings, numbers, and logicals of length one.

isScalarOrTis checks whether its argument is a FAME scalar or a tis (Time Indexed Series) object.

Usage

is.scalar(x)
isFameScalar(x)
isScalarOrTis(x)

Arguments

x

object to be checked. For is.scalar, it should be a number.

Value

• TRUE or FALSE.

Examples

is.scalar(42)
isFameScalar("this is a scalar, since it has length one")
isFameScalar(c("returns FALSE", "since it has length two"))
isFameScalar(today())
isScalarOrTis(today())