indexBytes: Index information

Description Usage Arguments Details Value Note Author(s) See Also

View source: R/index.R

Description

Some functions giving information about indices

Usage

1
2
3
4
5
6
7
8
indexNodes(obj)
indexBytes(obj)
## S3 method for class 'index'
print(x, tree = FALSE, ...)
## S3 method for class 'index'
str(object, ...)
## S3 method for class 'index'
length(x)

Arguments

x

an object of class ‘index’

obj

an object of class ‘index’

object

an object of class ‘index’

tree

TRUE to print the tree (default FALSE)

...

ignored or passed

Details

indexNodes returns number of tree nodes
indexBytes returns indes size in bytes
print.index prints index info and optionally tree
str.index removes class and calls NextMethod("str")
length.index identical to length of original vector
names.index currently forbidden
names<-.index currently forbidden

Value

Functions indexNodes, indexBytes and length.index return an integer (number of nodes, number of bytes, length of vector).

Note

There are dummy functions names.index, names<-.index and [<-.index that catch non-supported use of these generics on index objects.

Author(s)

Jens Oehlschl<e4>gel

See Also

index, length, object.size


rindex documentation built on Sept. 1, 2018, 1:04 a.m.

Related to indexBytes in rindex...