list

Full name SMRUCC.Rsharp.Runtime.Internal.Object.list Assembly REnv Members 45

A tuple paired list object model

01 Syntax

SMRUCC.Rsharp.Runtime.Internal.Object.list

02 Methods

Name	Overloads	Summary
.ctor	5	construct a new tuple list object from a named slot value collection.
add	2	add key-value directly, for add content data with possible duplicated names safely, use the list.unique_add()) method.
unique_add	1	add unique key-value safely
add	1	cast the given collection as array and then add into current tuple list
hasName	1	does list.slots has the specific name?
hasNames	1	check that all name inside the given names is exists in current data list.
slotKeys	1	get names with uncheck default index
listOf	1	all value element inside current tuple list is the given element type
getNames	1	this function may returns nothing if all index names are default index, example as: [[1]]
setNames	1	出错会返回错误消息
getValue	2	get value or default
ctypeInternal	1	cast data type
asGeneric	1	Try cast of the object type value to a generic type value
getByIndex	1
setByIndex	1	set value by index
getByName	2	If target key name is not found in list, then function will returns nothing
getBySynonyms	1	get raw value by a set of given synonyms.
setByName	1	add/updates of the key name associated value data.
empty	2	Create a tuple list object that contains no data.
scalar	1	Create a tuple list object that just contains one scalar value
set_empty	1	create a list with given slot names, but the corresponding slot value is nothing
subset	1	A shortcut of function list.getByName())
namedValues	1
getValue	1
asGeneric	2
ToString	1
GetVector	1
GetSlots	1
op_Implicit	1
checkTuple	1

03 Properties

Name	Overloads	Summary
length	1	gets the list.slots collection size
data	1	get all values collection from the slots symbol.
is_empty	1	check of the data list.slots is null or empty or not?
SlotValue	1	Get slot value by name
slots	1

04 Fields

Name	Overloads	Summary
EmptyListWarningMessage	1

05 Members

method .ctor overload 2 #

#ctor(list)

data clone

Parameters

Name	Type	Description
`list`	list	-

method .ctor overload 4 #

#ctor(IDictionary)

Create tuple list from a general dictionary set, dictionary value type could be anything

Parameters

Name	Type	Description
`table`	`IDictionary`	-

method .ctor overload 5 #

#ctor(Type)

Parameters

Name	Type	Description
`type`	`Type`	RsharpDataObject.elementType

method .ctor overload 3 #

#ctor(RType)

Parameters

Name	Type	Description
`type`	RType	RsharpDataObject.elementType

method .ctor #

#ctor(ArgumentReference())

construct a new tuple list object from a named slot value collection.

Parameters

Name	Type	Description
`data`	`ArgumentReference()`	a named slot value collection.

method add #

add(String, Object)

add key-value directly, for add content data with possible duplicated names safely, use the list.unique_add() method.

Remarks

this function has different behaviours when compares with the list.setByName():

this function just add slot value directly even if the given value is nothing
setByName function will removes slot if the value is nothing

Parameters

Name	Type	Description
`name`	`String`	-
`value`	`Object`	-

method add overload 2 #

add(String, String)

add a string value

Remarks

due to the reason of string is kind of a char collection so that the overlaod of the generic collection add method may caused the incorrect method reference.

create this function for deal with the string value overloads bug.

Parameters

Name	Type	Description
`name`	`String`	-
`str`	`String`	-

method unique_add #

unique_add(String, Object)

add unique key-value safely

Remarks

the duplicated name will be resolved safely in this function.

Parameters

Name	Type	Description
`name`	`String`	duplicated name will be appends a suffix string for avoid the key conflicts
`value`	`Object`	-

method add #

add``1(String, IEnumerable(Of ``0))

cast the given collection as array and then add into current tuple list

Type Parameters

Name	Description
`T`

Parameters

Name	Type	Description
`name`	`String`	-
`collection`	IEnumerable(Of ``0)	-

method hasName #

hasName(String)

does list.slots has the specific name?

Remarks

check for the dictionary key is existsed?

Parameters

Name	Type	Description
`name`	`String`	-

method hasNames #

hasNames(String())

check that all name inside the given names is exists in current data list.

Parameters

Name	Type	Description
`names`	`String()`	-

method slotKeys #

slotKeys

get names with uncheck default index

method listOf #

listOf(TypeCodes)

all value element inside current tuple list is the given element type

Parameters

Name	Type	Description
`elementMode`	TypeCodes	the element type for test

method getNames #

getNames

this function may returns nothing if all index names are default index, example as: [[1]]

Remarks

for get key names safely(avoid null reference) in the clr code, expression like slots.Keys.ToArray could be used. analso the function list.slotKeys() works for this situation.

method setNames #

setNames(String(), Environment)

出错会返回错误消息

Parameters

Name	Type	Description
`names`	`String()`	-
`envir`	Environment	-

method getValue overload 2 #

getValue``1(String(), Environment, ``0, Message)

get value or default

Remarks

this method will evaluate the value Expression to target T automatically.

Type Parameters

Name	Description
`T`

Parameters

Name	Type	Description
`synonym`	`String()`	-
`env`	Environment	-
`default`	``0	the default value.

method getValue #

getValue``1(String, Environment, ``0, Message)

get value or default

Remarks

this method will evaluate the value Expression to target T automatically.

Type Parameters

Name	Description
`T`

Parameters

Name	Type	Description
`name`	`String`	-
`env`	Environment	-
`default`	``0	the default value.

method ctypeInternal #

ctypeInternal``1(Object, Environment, Message)

cast data type

Type Parameters

Name	Description
`T`

Parameters

Name	Type	Description
`value`	`Object`	if value is an expression andalso T type is not an expression, then this function will try to evaluate the expression as value and then cast data type again.
`env`	Environment	-
`err`	Message	-

method asGeneric #

asGeneric``1(Environment, ``0, Message)

Try cast of the object type value to a generic type value

Type Parameters

Name	Description
`T`	the generic type that cast to

Parameters

Name	Type	Description
`env`	Environment	-
`default`	``0	the default element generic value if the type cast failure.
`err`	Message	gets the error message for the type cast failure from this parameter.

method getByIndex #

getByIndex(Int32)

Remarks

the given index value i should be a integer value from 1-based.

Parameters

Name	Type	Description
`i`	`Int32`	1-based index

method setByIndex #

setByIndex(Int32, Object, Environment)

set value by index

Remarks

the given index value i should be a integer value from 1-based.

Parameters

Name	Type	Description
`i`	`Int32`	1-based index
`value`	`Object`	any kind of the clr runtime value to store in this tuple list that associated with this index.
`envir`	Environment	-

method getByName #

getByName(String)

If target key name is not found in list, then function will returns nothing

Parameters

Name	Type	Description
`name`	`String`	-

method getByName overload 2 #

getByName(String())

Create a list subset

Parameters

Name	Type	Description
`names`	`String()`	A specific list keys that will be used for extract the subset elements from the original list to create a new list object.

method getBySynonyms #

getBySynonyms(String())

get raw value by a set of given synonyms.

Parameters

Name	Type	Description
`synonym`	`String()`	-

method setByName #

setByName(String, Object, Environment)

add/updates of the key name associated value data.

Remarks

NULL value will remove the target slot by name

Parameters

Name	Type	Description
`name`	`String`	-
`value`	`Object`	-
`envir`	Environment	-

method empty #

empty

Create a tuple list object that contains no data.

method empty overload 2 #

empty(list)

check of the given tuple list object is null or empty?

Parameters

Name	Type	Description
`list`	list	-

method scalar #

scalar(Object)

Create a tuple list object that just contains one scalar value

Parameters

Name	Type	Description
`x`	`Object`	-

method set_empty #

set_empty(IEnumerable(Of String))

create a list with given slot names, but the corresponding slot value is nothing

Parameters

Name	Type	Description
`slot_names`	`IEnumerable(Of String)`	-

method subset #

subset(String())

A shortcut of function list.getByName()

Parameters

Name	Type	Description
`keys`	`String()`	-

property length #

length

gets the list.slots collection size

property data #

data

get all values collection from the slots symbol.

property is_empty #

is_empty

check of the data list.slots is null or empty or not?

property SlotValue #

SlotValue(String)

Get slot value by name

Parameters

Name	Type	Description
`name`	`String`	-

Returns

returns nothing if there is no given name exists in the slots

field EmptyListWarningMessage #

EmptyListWarningMessage

property slots #

slots

method namedValues #

namedValues()

method getValue #

getValue(String(), Environment, T, Message)

method asGeneric #

asGeneric(Environment, T, Message)

method asGeneric overload 2 #

asGeneric(Func(Of Object, T))

method ToString #

ToString()

method GetVector #

GetVector(String())

method GetSlots #

GetSlots(Object)

method op_Implicit #

op_Implicit(Dictionary(Of String, Object))

method checkTuple #

checkTuple(String())