Vision Messages: TimeSeries

Profile of Class TimeSeries

Includes Classes: Collection, EnumeratedFunction, Function, IndexedCollection, TimeSeries


Object
  | 
Function
  | 
EnumeratedFunction
  | 
Collection
  | 
IndexedCollection
  | 
  +--- TimeSeries

A TimeSeries is a specialization of IndexedCollection whose index is a date.

Message Index

Messages

Synopsis:
TimeSeries * anObject

Description:
This message is used to perform vector multiplication between two lists or a list and a scalar value. If the supplied value is a scalar, the value is multiplied by each element in the recipient list. If the supplied value is a list, the operation is applied positionally.

Type: Method Returns: TimeSeries
Parameters:
1 - TimeSeries

Also Defined At:
| DateOffset | List | Undefined |

Synopsis:
TimeSeries + anObject

Description:
This message is used to perform vector addition between two lists or a list and a scalar value. If the supplied value is a scalar, the value is added to each element in the recipient list. If the supplied value is a list, the operation is applied positionally.

Type: Method Returns: TimeSeries
Parameters:
1 - TimeSeries

Also Defined At:
| Date | DateOffset | List | Undefined |

Synopsis:
TimeSeries - anObject

Description:
This message is used to perform vector subtraction between two lists or a list and a scalar value. If the supplied value is a scalar, the value is subtracted from each element in the recipient list. If the supplied value is a list, the operation is applied positionally.

Type: Method Returns: TimeSeries
Parameters:
1 - TimeSeries

Also Defined At:
| Date | List | Undefined |

Synopsis:
TimeSeries / anObject

Description:
This message is used to perform vector division between two lists or a list and a scalar value. If the supplied value is a scalar, the value divides each element in the recipient list. If the supplied value is a list, the operation is applied positionally.

Type: Method Returns: TimeSeries
Parameters:
1 - TimeSeries

Also Defined At:
| List | Undefined |

Synopsis:
TimeSeries <- anObject

Description:
Assigns the value provided as of the default date into the recipient. This operations does NOT create new points in the time series; it updates the point on or before the default date. If there is no point on or before the default, the value is stored at the date 1/1/1. <- only works with true time series, not methods (i.e., if formula is a method defined to compute a ratio of two numbers, the <- message can not be used to change the value of formula).

Type: Method Returns: TimeSeries
Parameters:
1 - Object

all:

Synopsis:
Collection all: booleanBlock

Description:
Returns TRUE if all elements in recipient respond to supplied block with the value TRUE.

Type: Method Returns: Boolean
Parameters:
1 - Block

anElement

Synopsis:
Collection anElement

Description:
Extracts a single element from the recipient List. The last element in the List is returned. Useful when dealing with single element lists to strip of the last level of protocol.

Type: Method Returns: TimeSeries

any:

Synopsis:
Collection any: booleanBlock

Description:
Returns TRUE if any element in recipient respond to supplied block with the value TRUE.

Type: Method Returns: Boolean
Parameters:
1 - Block

append:

Synopsis:
Collection append: aList

Description:
Appends the supplied List to a copy of the recipient List. The original list is not altered.

Type: Method Returns: List
Parameters:
1 - List

asOf:

Synopsis:
TimeSeries asOf: aDate

Description:
Returns the value of the time series as of the supplied date. If no value is stored for the date, the closest date prior to the supplied date is used.

Type: Method Returns: Object
Parameters:
1 - Date

Also Defined At:
| Block |

asOf:assign:

Synopsis:
TimeSeries asOf: aDate assign: aValue

Description:
Assigns supplied value into the time series as of the supplied date. This operation does NOT create new points in the time series; it updates the first date on or before the supplied date that already exists in the time series. Message only works with true time series, not methods (i.e., if formula is a method defined to compute a ratio of two numbers, the message can not be used to change the value of formula).

Type: Method Returns: TimeSeries
Parameters:
1 - Date
2 - Object

asOf:put:

Synopsis:
TimeSeries asOf: aDate put: anObject

Description:
Assigns supplied value into the time series as of the date supplied. The message creates a new time point in the time series if the date did not exist. Message only works with true time series, not methods (i.e., if formula is a method defined to compute a ratio of two numbers, the message can not be used to change the value of formula).

Type: Method Returns: TimeSeries
Parameters:
1 - Date
2 - Object

asSelf

Synopsis:
Function asSelf

Description:
Returns the original object.

Type: Primitive Returns: Function
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

asSelf

Synopsis:
EnumeratedFunction asSelf

Description:
Returns the original object.

Type: Primitive Returns: EnumeratedFunction
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

asSelf

Synopsis:
Collection asSelf

Description:
Returns the original object.

Type: Primitive Returns: Collection
Also Defined At:
| Block | Boolean | Classification | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

asSelf

Synopsis:
IndexedCollection asSelf

Description:
Returns the original object.

Type: Primitive Returns: IndexedCollection
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

asSelf

Synopsis:
TimeSeries asSelf

Description:
Returns the original object.

Type: Primitive Returns: TimeSeries
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | Undefined | Utility |

at:

Synopsis:
IndexedCollection at: index

Description:
Returns the value of the recipient IndexedCollection stored at the supplied index.

Type: Method Returns: Object
Parameters:
1 - Object

Also Defined At:
| Dictionary | List | String |

at:put:

Synopsis:
IndexedCollection at: index put: aValue

Description:
Stores the supplied value at the supplied index in the recipient IndexedCollection.

Type: Method Returns: Object
Parameters:
1 - Object
2 - Object

Also Defined At:
| Dictionary | List | String |

aveForDateRange:

Synopsis:
TimeSeries aveForDateRange: aDateRange

Description:
computes the average value of a time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

average

Synopsis:
Collection average

Description:
Computes the average for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

average:

Synopsis:
Collection average: aBlock

Description:
Evaluates the formula provided in supplied Block for each element in the list and computes the average value. NA values are not included in the average.

Type: Method Returns: Number
Parameters:
1 - Block

average:withWeights:

Synopsis:
Collection average: aBlock withWeights: bBlock

Description:
Returns the weighted average using the formula in bBlock to weight the formula supplied in aBlock.

Type: Method Returns: Number
Parameters:
1 - Block
2 - Block

basicAverage:

Synopsis:
TimeSeries basicAverage:

Type: Primitive Returns: Object
Also Defined At:
| IndexedList | List |

basicMax:

Synopsis:
TimeSeries basicMax:

Type: Primitive Returns: Object
Also Defined At:
| IndexedList | List |

basicMin:

Synopsis:
TimeSeries basicMin:

Type: Primitive Returns: Object
Also Defined At:
| IndexedList | List |

basicProduct:

Synopsis:
TimeSeries basicProduct:

Type: Primitive Returns: Object
Also Defined At:
| IndexedList | List |

basicRankDown:usingCollector:

Synopsis:
TimeSeries basicRankDown:usingCollector:

Type: Primitive Returns: Object
Parameters:
1 - String
2 - String

Also Defined At:
| IndexedList | List |

basicRankUp:usingCollector:

Synopsis:
TimeSeries basicRankUp:usingCollector:

Type: Primitive Returns: Object
Parameters:
1 - String
2 - String

Also Defined At:
| IndexedList | List |

basicRunningTotal:usingCollector:

Synopsis:
TimeSeries basicRunningTotal:usingCollector:

Type: Primitive Returns: Object
Parameters:
1 - String
2 - String

Also Defined At:
| IndexedList | List |

basicSortDown:

Synopsis:
TimeSeries basicSortDown: aBlock

Description:
Evaluates the statements provided in the supplied block and sorts the TimeSeries in descending order. Sort is highest to lowest for numbers. Sort is ZZZ through A for strings.

Type: Primitive Returns: List
Parameters:
1 - Block

Also Defined At:
| IndexedList | List |

basicSortUp:

Synopsis:
TimeSeries basicSortUp: aBlock

Description:
Evaluates the statements provided in the supplied block and sorts the TimeSeries in ascending order. Sort is lowest to highest for numbers. Sort is A through Z for strings.

Type: Primitive Returns: List
Parameters:
1 - Block

Also Defined At:
| IndexedList | List |

basicTotal:

Synopsis:
TimeSeries basicTotal:

Type: Primitive Returns: Object
Also Defined At:
| IndexedList | List |

cGrow

Synopsis:
TimeSeries cGrow

Description:
Computes the compound growth rate of the time series.

Type: Method Returns: Number

cGrowForDateRange:

Synopsis:
TimeSeries cGrowForDateRange: aDateRange

Description:
Computes the compound growth rate of the time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

changeLag:

Synopsis:
TimeSeries changeLag: aDateOffset

Description:
Computes the absolute change between the value of the time series as of the default date and an earlier relative date.

Type: Method Returns: Number
Parameters:
1 - DateOffset

Also Defined At:
| Block |

changeLead:

Synopsis:
TimeSeries changeLead: aDateOffset

Description:
Computes the absolute change between the value of the time series as of the default date and a future relative date.

Type: Method Returns: Number
Parameters:
1 - DateOffset

Also Defined At:
| Block |

classDescriptor

Synopsis:
Function classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

classDescriptor

Synopsis:
EnumeratedFunction classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

classDescriptor

Synopsis:
Collection classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

classDescriptor

Synopsis:
IndexedCollection classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

classDescriptor

Synopsis:
TimeSeries classDescriptor

Description:
Reference to the object which describes the class. Class level information is stored here.

Type: Constant Returns: Object
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | Undefined | Utility |

collect:

Synopsis:
Collection collect: aBlock

Description:
Uses supplied block to create an extension of recipient List. The value of the block is assigned to the variable value. The returned extension responds to the value message.

Type: Method Returns: List
Parameters:
1 - Block

Also Defined At:
| Object |

collect:with:

Synopsis:
Collection collect: aBlock with: input

Description:
Uses supplied block to create an extension of recipient List extended by the variable 'value'. The block is evaluated using the supplied input parameter.

Type: Method Returns: List
Parameters:
1 - Block
2 - Object

collectGroupsForCriteria:atLevel:in:withKeys:

Synopsis:
Collection collectGroupsForCriteria: blocks atLevel: level in: list withKeys: keys

Type: Method Returns: Object

collectListElementsFrom:

Synopsis:
Collection collectListElementsFrom: aBlock

Description:
Evaluates the statements provided in supplied block for each element in the list and produces a new list containing these elements. Used to combine a list of lists. The supplied block must evaluate to a list. For example, the expression: 5 sequence collectListElementsFrom: [ ^self sequence ] returns the list elements 1, 1, 2, 1, 2, 3, 1, 2, 3, 4, 1, 2, 3, 4, 5

Type: Method Returns: List
Parameters:
1 - Block

compound

Synopsis:
Collection compound

Description:
Computes the compounded value for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

compound:

Synopsis:
Collection compound: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes the compounded value.

Type: Method Returns: Number
Parameters:
1 - Block

copyListElements

Synopsis:
Collection copyListElements

Description:
Produces a copy of the recipient list. Should be used to avoid modifying the recipient List.

Type: Method Returns: List

correlate:with:

Synopsis:
Collection correlate: blockX with: blockY

Description:
Computes the correlation of all points in the recipient based on evaluation of the formula provided by the two supplied blocks.

Type: Method Returns: Number
Parameters:
1 - Block
2 - Block

count

Synopsis:
TimeSeries count

Description:
Counts the number of points in the TimeSeries.

Type: Primitive Returns: Integer
Also Defined At:
| IndexedList | List | String |

decileDown:

Synopsis:
Collection decileDown: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its decile (highest values = 1; lowest values = 10).

Type: Method Returns: List
Parameters:
1 - Block

decileDown:by:

Synopsis:
Collection decileDown: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a decile value for each element relative to its group. The result object is the original collection extended by the variable 'decile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

decileDown:by:by:

Synopsis:
Collection decileDown: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a decile value for each element relative to its group. The result object is the original collection extended by the variable 'decile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

decileDown:using:

Synopsis:
Collection decileDown: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its decile (highest values = 1; lowest values = 10). The decile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

decileUp:

Synopsis:
Collection decileUp: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its decile (lowest values = 1; highest = 10).

Type: Method Returns: List
Parameters:
1 - Block

decileUp:by:

Synopsis:
Collection decileUp: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a decile value for each element relative to its group. The result object is the original collection extended by the variable 'decile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

decileUp:by:by:

Synopsis:
Collection decileUp: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a decile value for each element relative to its group. The result object is the original collection extended by the variable 'decile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

decileUp:using:

Synopsis:
Collection decileUp: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its decile (highest values = 1; lowest values = 10). The decile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

defaultInstance

Synopsis:
Function defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Returns: Function
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

defaultInstance

Synopsis:
EnumeratedFunction defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Returns: EnumeratedFunction
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

defaultInstance

Synopsis:
Collection defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Returns: Collection
Also Defined At:
| Block | Boolean | Classification | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

defaultInstance

Synopsis:
IndexedCollection defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Returns: IndexedCollection
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

defaultInstance

Synopsis:
TimeSeries defaultInstance

Description:
Returns the default instance of the recipient object's class

Type: Constant Returns: TimeSeries
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | OpenVision | Schema | String | Undefined | Utility |

delete:

Synopsis:
TimeSeries delete: aDate

Description:
Deletes the point at the specified date from the time series. Only deletes the point if the exact date exists in the time series.

Type: Method Returns: Object
Parameters:
1 - Date

Also Defined At:
| Dictionary | IndexedList |

deleteAllPoints

Synopsis:
TimeSeries deleteAllPoints

Description:
Deletes all points in the recipient time series.

Type: Method Returns: Object

deleteColumn

Synopsis:
TimeSeries deleteColumn

Type: Primitive Returns: Object

deleteColumnForDate:

Synopsis:
TimeSeries deleteColumnForDate: aDate

Description:
Removes supplied date from the TimeSeries for all instances in recipient's class

Type: Method Returns: TimeSeries
Parameters:
1 - Date

deletePoint

Synopsis:
TimeSeries deletePoint

Type: Primitive Returns: Object

difference:

Synopsis:
Collection difference: aList

Description:
This message returns a list of two elements: the first element contains
the list of elements that are in list 1 and not in list 2; the second
element contains the list of elements that are in list 2 and not list 1.
For example:

!diffs <- (1,2,3,4,5) difference: (3,4,5,6) ;
"In 1 not 2" print ; diffs at: 1 . do: [ print ] ; newLine print;
"In 2 not 2" print ; diffs at: 2 . do: [ print ] ;

Type: Method Returns: List
Parameters:
1 - List

displayAll

Synopsis:
TimeSeries displayAll

Description:
Displays all the date-value pairs that exist in the time series.

Type: Method Returns: Object
Also Defined At:
| Block |

displayAllChanges

Synopsis:
TimeSeries displayAllChanges

Description:
Displays all date-value pairs that in the recipient TimeSeries that contain a new value.

Type: Method Returns: Object

do:

Synopsis:
TimeSeries do: aBlock

Description:
Evaluates the criteria provided in supplied block for each element in the time series.

Type: Primitive Returns: TimeSeries
Parameters:
1 - Block

Also Defined At:
| IndexedList | List | Object |

effectiveDate

Synopsis:
TimeSeries effectiveDate

Description:
Returns the date on or before the default date. If there are no points in the time series on or before the default date, NA is returned.

Type: Method Returns: Date

effectiveDateAsOf:

Synopsis:
TimeSeries effectiveDateAsOf: aDate

Description:
Returns the date in the time series on or before the supplied date. If there are no points in the time series on or before the default date, NA is returned.

Type: Method Returns: Date
Parameters:
1 - Date

exclude:

Synopsis:
Collection exclude: aList

Description:
Finds the elements in the recipient list that are NOT in the supplied list.

Type: Method Returns: List
Parameters:
1 - List

exclude:using:

Synopsis:
Collection exclude: aList using: aBlock

Description:
Excludes elements in aList from recipient using rules supplied by block to strip any extensions from elements before comparing for equality.

Type: Method Returns: List
Parameters:
1 - List
2 - Block

excludesElement:

Synopsis:
Collection excludesElement: anObject

Description:
Returns TRUE if recipient List does not include supplied object.

Type: Method Returns: Boolean
Parameters:
1 - Object

extendBy:

Synopsis:
TimeSeries extendBy: aBlock

Description:
Evaluates supplied block for each element in the time series, where supplied block specifies a set of new variables to which each element in the time series can respond.

Type: Primitive Returns: TimeSeries
Parameters:
1 - Block

Also Defined At:
| IndexedList | List | Object |

extractExactValuesForDateRange:

Synopsis:
TimeSeries extractExactValuesForDateRange: aDateRange

Description:
Creates a new time series that contains a point for each value in the supplied date range whose value is extracted from the recipient time series. If there is no value on the exact date in the date range, the default value for the time series is stored as of the date. The value as of 1/1/1 is used as the default value.

Type: Method Returns: TimeSeries
Parameters:
1 - DateRange

extractForDateRange:

Synopsis:
TimeSeries extractForDateRange: aDateRange

Description:
Creates a new time series that contains a point for each value in the supplied date range whose value is extracted from the recipient time series.

Type: Method Returns: TimeSeries
Parameters:
1 - DateRange

Also Defined At:
| Block |

first:

Synopsis:
Collection first: n

Description:
Selects the first 'n' non-NA, non-Default elements from the recipient.

Type: Method Returns: Collection
Parameters:
1 - Integer

firstDate

Synopsis:
TimeSeries firstDate

Description:
Returns date of the first point in the time series. If the time series is empty, NA is returned.

Type: Method Returns: Date

firstObservation

Synopsis:
TimeSeries firstObservation

Description:
Returns the value stored at the first point in the time series. If the time series is empty, NA is returned.

Type: Method Returns: Object

from:

Synopsis:
TimeSeries from: date1

Description:
Returns the subset of points in the recipient on or after the supplied date.

Type: Method Returns: TimeSeries
Parameters:
1 - Date

Also Defined At:
| String |

from:to:

Synopsis:
TimeSeries from: date1 to: date2

Description:
Returns the subset of points in the recipient that fall with the supplied dates.

Type: Method Returns: TimeSeries
Parameters:
1 - Date
2 - Date

Also Defined At:
| String |

gMean

Synopsis:
Collection gMean

Description:
Computes the geometric mean of the time series

Type: Method Returns: Number

gMean:

Synopsis:
Collection gMean: aBlock

Description:
Evaluates the formula provided in supplied Block for each element in the list and computes the geometric mean.

Type: Method Returns: Number
Parameters:
1 - Block

gMeanForDateRange:

Synopsis:
TimeSeries gMeanForDateRange: aDateRange

Description:
Computes the geometric mean of the time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

groupPrintUsing:

Synopsis:
Collection groupPrintUsing: aBlock

Description:
Groups recipient List by supplied block and displays a report showing the count in each group.

Type: Method Returns: Object
Parameters:
1 - Block

groupedBy:

Synopsis:
Collection groupedBy: aBlock

Description:
Groups the recipient list based on the criteria specified by the supplied block. After the groupedBy: message is sent, each element in the resultant list responds to the message groupList which returns the list of elements in that group.

Type: Method Returns: List
Parameters:
1 - Block

groupedBy:and:

Synopsis:
Collection groupedBy: block1 and: block2

Description:
Groups the recipient list based on the criteria specified by the two supplied criteria. Each element in the resultant list responds to the message 'groupList' which returns the list of elements in that group. The value of each group is defined as the string formed by: first criteria value.second critria value

Type: Method Returns: List
Parameters:
1 - Block
2 - Block

groupedBy:in:

Synopsis:
Collection groupedBy: block in: list

Description:
Groups the recipient collection based on the criteria specified by supplied blocks. The resultant list contains one element for each value that is included in supplied list. Unlike 'groupedBy:union:', groups that do not appear in supplied list are eliminated.

Type: Method Returns: Collection
Parameters:
1 - List

groupedBy:intersect:

Synopsis:
Collection groupedBy: block intersect: list

Description:
Groups the recipient collection based on the criteria specified by supplied blocks. The resultant list contains one element for each value that is included in both the supplied list AND the result of applying the supplied block to the recipient collection.

Type: Method Returns: Collection
Parameters:
1 - List

groupedBy:union:

Synopsis:
Collection groupedBy: block union: list

Description:
Groups the recipient collection based on the criteria specified by supplied blocks. The resultant list contains one element for each value that is included in supplied list OR that results from applying the supplied block to the recipient collection. For example, companyList groupedBy: [ country ] union: Country masterList will return a list with one entry for each Country including countries not represented in 'companyList' (where groupList count will be 0.

Type: Method Returns: Collection
Parameters:
1 - List

groupedBy:usingCollector:

Synopsis:
TimeSeries groupedBy: aBlock usingCollector: aBlock

Description:
Groups the recipient TimeSeries based on the criteria specified by block1. The second block provides the name of the extension. The groupedBy: message is implemented using 'groupList' as the collector.

Type: Primitive Returns: TimeSeries
Parameters:
1 - Block
2 - Block

Also Defined At:
| IndexedList | List |

groupedBy:usingCutoffs:

Synopsis:
Collection groupedBy: aBlock usingCutoffs: aList

Description:
Groups recipient List into partitions specified in aList, based on criteria specified in aBlock. The supplied list should be a list of Numbers.

Type: Method Returns: List
Parameters:
1 - Block
2 - List

groupedByCriteria:

Synopsis:
Collection groupedByCriteria: aBlockList

Description:
Groups the recipient collection based on the criteria specified by supplied list of blocks. The resultant list contains one element for each combination of values present from processing the supplied blocks. Each element in the resultant list responds to the message 'keyList' which is the list of values associated with this group, one per supplied block. Each element in the resultant list responds to the message 'groupList' which returns the list of elements in the specific combination of block values. For example, Company masterList groupedByCriteria: [ sector ] , [ country ] returns a list of sector/country pairs. To display the name of each key and the group count, use: Company masterList groupedByCriteria: [ sector ] , [ country ] . do: [ keyList do: [ name print: 20 ] ; #-- print keys groupList count printNL ; #-- print count ] ;

Type: Method Returns: Collection
Parameters:
1 - List

groupedByString:

Synopsis:
Collection groupedByString: aBlock

Description:
Used as an alternative to 'groupedBy:' when the supplied block returns string values, this version guarantees that strings with identical content will be in the same group. The standard 'groupedBy:' will place unique string in separate groups even if they have identical content.

Type: Method Returns: List
Parameters:
1 - Block

harmonicMean

Synopsis:
Collection harmonicMean

Description:
Computes the harmonicMean for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

harmonicMean:

Synopsis:
Collection harmonicMean: aBlock

Description:
Evaluates the formula provided in supplied Block for each element in the list and computes the harmonicMean value.

Type: Method Returns: Number
Parameters:
1 - Block

harmonicMean:withWeights:

Synopsis:
Collection harmonicMean: aBlock withWeights: bBlock

Description:
Returns the weighted harmonic mean using the formula in bBlock to weight the value supplied in aBlock.

Type: Method Returns: Number
Parameters:
1 - Block
2 - Block

histogram:title:

Synopsis:
Collection histogram: aBlock title: aString

Description:
Produces a distribution chart based on each element's value of the supplied block.

Type: Method Returns: Object
Parameters:
1 - Block
2 - String

includesElement:

Synopsis:
Collection includesElement: anObject

Description:
Returns TRUE if the recipient list does include the supplied object.

Type: Method Returns: Boolean
Parameters:
1 - Object

intersect:

Synopsis:
Collection intersect: aList

Description:
Finds the elements that are in BOTH the recipient list and supplied list

Type: Method Returns: List
Parameters:
1 - List

intersect:using:

Synopsis:
Collection intersect: aList using: aBlock

Description:
Finds intersection of elements in aList and recipient using rules supplied by block to strip any extensions from elements before comparing for equality.

Type: Method Returns: List
Parameters:
1 - List
2 - Block

intervalEnd

Synopsis:
TimeSeries intervalEnd

Type: Primitive Returns: Object

intervalStart

Synopsis:
TimeSeries intervalStart

Type: Primitive Returns: Object

isCollection

Synopsis:
Collection isCollection

Description:
Returns a TRUE value when sent to any collection.

Type: Constant Returns: TRUE
Also Defined At:
| Object |

isDefault

Synopsis:
Collection isDefault

Description:
Returns TRUE if recipient collection is empty.

Type: Method Returns: TRUE
Also Defined At:
| Date | Object | String | Undefined |

isEnumeratedFunction

Synopsis:
EnumeratedFunction isEnumeratedFunction

Description:
Returns a TRUE value when sent to any EnumeratedFunction.

Type: Constant Returns: TRUE
Also Defined At:
| Object |

isEquivalentTo:

Synopsis:
Collection isEquivalentTo: object

Description:
Returns TRUE if the recipient collection contains the same elements as the supplied collection.

Type: Method Returns: Boolean
Parameters:
1 - Object

Also Defined At:
| Object |

isFunction

Synopsis:
Function isFunction

Description:
Returns a TRUE value when sent to any Function.

Type: Constant Returns: TRUE
Also Defined At:
| Object |

isIndexedCollection

Synopsis:
IndexedCollection isIndexedCollection

Description:
Returns a TRUE value when sent to any IndexedCollection.

Type: Constant Returns: TRUE
Also Defined At:
| Object |

isTimeSeries

Synopsis:
TimeSeries isTimeSeries

Description:
Returns a TRUE value when sent to any time series.

Type: Constant Returns: TRUE
Also Defined At:
| Object |

iterate:

Synopsis:
Collection iterate: block

Description:
This message is used to consider each element in the recipient collection or date range one at a time in sequential order. Unlike the 'do:' message which operates in parallel, this message works sequentially and may be much slower. It is useful in cases where you need to use the results of a prior element in each iteration and where the size of the structures generated by parallel execution consumes more memorry resource than desired.

Type: Method Returns: Collection
Parameters:
1 - Block

Also Defined At:
| DateRange | TimeSeries |

iterate:

Synopsis:
TimeSeries iterate: block

Description:
This message is used to consider each element in the recipient collection or date range one at a time in sequential order. Unlike the 'do:' message which operates in parallel, this message works sequentially and may be much slower. It is useful in cases where you need to use the results of a prior element in each iteration and where the size of the structures generated by parallel execution consumes more memorry resource than desired.

Type: Method Returns: Object
Also Defined At:
| Collection | DateRange |

iterate:by:

Synopsis:
TimeSeries iterate: aBlock by: anInteger

Description:
Similar to the 'do:' message. The supplied integer is used to process recipient TimeSeries as a series of sublists.

Type: Primitive Returns: Object
Parameters:
1 - Block
2 - Integer

Also Defined At:
| IndexedList | List |

lag:

Synopsis:
TimeSeries lag: aDateOffset

Description:
Returns the value of the time series as of a date relative to the default date. The derived date is defined at: ^date - aDateOffset. If no value is stored for the derived date, the closest date prior to the supplied date is used.

Type: Method Returns: Object
Parameters:
1 - DateOffset

Also Defined At:
| Block |

last:

Synopsis:
Collection last: n

Description:
Selects the last 'n' non-NA, non-Default elements from the recipient.

Type: Method Returns: Collection
Parameters:
1 - Integer

lastDate

Synopsis:
TimeSeries lastDate

Description:
Returns date of the last point in the time series.

Type: Method Returns: Date

lastObservation

Synopsis:
TimeSeries lastObservation

Description:
Returns the value stored at the last point in the time series. If the time series is empty, NA is returned.

Type: Method Returns: Object

latest

Synopsis:
TimeSeries latest

Description:
Returns the value of the time series as of the current date. Identical to ts asOf: ^today.

Type: Method Returns: Object
Also Defined At:
| Block |

lead:

Synopsis:
TimeSeries lead: aDateOffset

Description:
Returns the value of the time series as of a date relative to the default date. The derived date is defined as: ^date + aDateOffset. If no value is stored for the derived date, the closest date prior to the supplied date is used.

Type: Method Returns: Object
Parameters:
1 - DateOffset

Also Defined At:
| Block |

linkElements

Synopsis:
Collection linkElements

Description:
Extends each element in the collectionby the variables 'prior' and 'next'
which corresponds to the elements in the recipient lilst that are before
and after each element. For example:

5 sequence linkElements
do: [ print ; prior print ; next printNL ] ;

Type: Method Returns: Collection

lsGrow

Synopsis:
TimeSeries lsGrow

Description:
Computes the least squares growth value of the recipinent time series.

Type: Method Returns: Number
Parameters:
1 - DateRange

lsGrowForDateRange:

Synopsis:
TimeSeries lsGrowForDateRange: aDateRange

Description:
Computes the least squares growth value of the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

max

Synopsis:
Collection max

Description:
Computes the maximum for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

max:

Synopsis:
Collection max: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and returns the maximum value.

Type: Method Returns: Number
Parameters:
1 - Block

Also Defined At:
| Undefined |

maxForDateRange:

Synopsis:
TimeSeries maxForDateRange: aDateRange

Description:
Computes the maximum value of the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

median

Synopsis:
Collection median

Description:
Computes the median value of the recipient time series.

Type: Method Returns: Number

median:

Synopsis:
Collection median: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes the median (middle) value. NA values are not included.

Type: Method Returns: Number
Parameters:
1 - Block

medianForDateRange:

Synopsis:
TimeSeries medianForDateRange: aDateRange

Description:
Computes the median value of the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

mgroupedBy:

Synopsis:
Collection mgroupedBy: aBlock

Description:
Groups the recipient list using result of block, where supplied block should
generate a list as its result. Elements in the original list will be
included in one or more groupLists. For example, if instances of the class
EntityCategory respond to the message 'entities' with the list of entities
included in the instance, then the expression:

EntityCategory masterList mgroupedBy: [ entities ]

returns a list of the entities included in any EntityCategory where each
element of this new list responds to the 'groupList' message with the
list of EntityCategories that include the element.

Type: Method Returns: List
Parameters:
1 - Block

min

Synopsis:
Collection min

Description:
Computes the minimum for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

min:

Synopsis:
Collection min: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and returns the minimum value.

Type: Method Returns: Number
Parameters:
1 - Block

Also Defined At:
| Undefined |

minForDateRange:

Synopsis:
TimeSeries minForDateRange: aDateRange

Description:
Computes the minimum value of the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

mode

Synopsis:
Collection mode

Description:
Computes the mode for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

mode:

Synopsis:
Collection mode: aBlock

Description:
Evaluates the formula provided in aBlock for each element in the list and computes the mode (most frequently occurring value). NA values are not included.

Type: Method Returns: Number
Parameters:
1 - Block

modeForDateRange:

Synopsis:
TimeSeries modeForDateRange: aDateRange

Description:
Computes the mode value of the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

ncount:

Synopsis:
TimeSeries ncount:

Type: Primitive Returns: Object
Parameters:
1 - String

Also Defined At:
| IndexedList | List |

new

Synopsis:
Function new

Description:
Disables the 'new' message.

Type: Method Returns: Function
Also Defined At:
| Boolean | Collection | DateRange | Dictionary | Object | Undefined |

new

Synopsis:
Collection new

Description:
Creates a new instance of the recipient object's class.

Type: Method Returns: Collection
Also Defined At:
| Boolean | DateRange | Dictionary | Object | Undefined |

newValueCell

Synopsis:
TimeSeries newValueCell

Type: Primitive Returns: Object

newValueCell:

Synopsis:
TimeSeries newValueCell: aDate

Type: Method Returns: Object
Parameters:
1 - String

Also Defined At:
| IndexedList |

nextDate

Synopsis:
TimeSeries nextDate

Description:
Returns the date after the default date. If there are no points in the time series after the default date, NA is returned.

Type: Method Returns: Date

nextDateAsOf:

Synopsis:
TimeSeries nextDateAsOf: aDate

Description:
Returns the date in the time series after the supplied date. If there are no points in the time series after the supplied date, NA is returned.

Type: Method Returns: Date
Parameters:
1 - Date

nonDefaults

Synopsis:
Collection nonDefaults

Description:
Selects any element in the recipient collection that is not a default.

Type: Method Returns: Collection

normalize

Synopsis:
Collection normalize

Description:
Returns the recipient extended by the property 'norm' assuming the recipient is a collectin of numbers.

Type: Method Returns: Collection
Parameters:
1 - Block

normalize:

Synopsis:
Collection normalize: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the collection and computes its normalized value based on the mean and standard deviation of the collection. Returns the recipient extended by the property 'norm'.

Type: Method Returns: Collection
Parameters:
1 - Block

normalize:by:

Synopsis:
Collection normalize: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a normalized
value for each element relative to its group. The result object is the original
collection extended by the variable 'norm'. For example:
Company masterList normalize: [ sales ] by: [ country ]

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

normalize:by:by:

Synopsis:
Collection normalize: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a
normalized value for each element relative to its group. The result object
is the original collection extended by the variable 'norm'. For example:
Company masterList
normalize: [ sales ] by: [ country ] by: [ industry ]

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

numberElements

Synopsis:
Collection numberElements

Description:
Extends each element in the list by the variable 'position' which corresponds to its position number in the list.

Type: Method Returns: Collection

numberElementsInReverse

Synopsis:
Collection numberElementsInReverse

Description:
Extends each element in the list by the variable 'position' which corresponds to its position number in the list when the list is sorted in reverse order.

Type: Method Returns: Collection

on:

Synopsis:
TimeSeries on: aDate

Description:
Returns the value of the time series on the supplied date. If no value is stored for the date, NA is returned.

Type: Method Returns: Object
Parameters:
1 - Date

pctChangeLag:

Synopsis:
TimeSeries pctChangeLag: aDateOffset

Description:
Computes the percent change between the value of the time series as of the default date and an earlier relative date.

Type: Method Returns: Number
Parameters:
1 - DateOffset

Also Defined At:
| Block |

pctChangeLead:

Synopsis:
TimeSeries pctChangeLead: aDateOffset

Description:
Computes the percent change between the value of the time series as of the default date and a late relative date.

Type: Method Returns: Number
Parameters:
1 - DateOffset

Also Defined At:
| Block |

percentileDown:

Synopsis:
Collection percentileDown: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its percentile (highest values = 1; lowest values = 100).

Type: Method Returns: List
Parameters:
1 - Block

percentileDown:by:

Synopsis:
Collection percentileDown: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a percentile value for each element relative to its group. The result object is the original collection extended by the variable 'percentile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

percentileDown:by:by:

Synopsis:
Collection percentileDown: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a percentile value for each element relative to its group. The result object is the original collection extended by the variable 'percentile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

percentileDown:using:

Synopsis:
Collection percentileDown: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its percentile (highest values = 1; lowest values = 100). The percentile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

percentileUp:

Synopsis:
Collection percentileUp: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its percentile (lowest values = 1; highest = 100).

Type: Method Returns: List
Parameters:
1 - Block

percentileUp:by:

Synopsis:
Collection percentileUp: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a percentile value for each element relative to its group. The result object is the original collection extended by the variable 'percentile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

percentileUp:by:by:

Synopsis:
Collection percentileUp: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a percentile value for each element relative to its group. The result object is the original collection extended by the variable 'percentile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

percentileUp:using:

Synopsis:
Collection percentileUp: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its percentile (lowest values = 1; highest values = 100). The percentile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

print

Synopsis:
TimeSeries print

Description:
Redefines the standard print message.

Type: Method Returns: TimeSeries
Also Defined At:
| Block | Date | DateOffset | DateRange | Entity | IndexedList | List | Object | String | Undefined |

product

Synopsis:
Collection product

Description:
Computes the product for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

product:

Synopsis:
Collection product: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes the product of the values.

Type: Method Returns: Number
Parameters:
1 - Block

productForDateRange:

Synopsis:
TimeSeries productForDateRange: aDateRange

Description:
Computes the product of the values in the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

put:

Synopsis:
TimeSeries put: anObject

Description:
Assigns supplied value into the time series as of the default date. This message creates a new time point in the time series if the date did not exist. Message only works with true time series, not methods (i.e., if formula is a method defined to compute a ratio of two numbers, the message can not be used to change the value of formula).

Type: Method Returns: TimeSeries
Parameters:
1 - Object

quintileDown:

Synopsis:
Collection quintileDown: aBlock

Description:
Evaluates the formula provided in aBlock for each element in the list and computes its quintile (highest values = 1; lowest values = 5)

Type: Method Returns: List
Parameters:
1 - Block

quintileDown:by:

Synopsis:
Collection quintileDown: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a quintile value for each element relative to its group. The result object is the original collection extended by the variable 'quintile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

quintileDown:by:by:

Synopsis:
Collection quintileDown: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a quintile value for each element relative to its group. The result object is the original collection extended by the variable 'quintile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

quintileDown:using:

Synopsis:
Collection quintileDown: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its quintile (highest values = 1; lowest values = 5). The quintile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

quintileUp:

Synopsis:
Collection quintileUp: aBlock

Description:
Evaluates the formula provided in aBlock for each element in the list and computes its quintile (lowest values = 1; highest = 5).

Type: Method Returns: List
Parameters:
1 - Block

quintileUp:by:

Synopsis:
Collection quintileUp: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a quintile value for each element relative to its group. The result object is the original collection extended by the variable 'quintile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

quintileUp:by:by:

Synopsis:
Collection quintileUp: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a quintile value for each element relative to its group. The result object is the original collection extended by the variable 'quintile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

quintileUp:using:

Synopsis:
Collection quintileUp: aBlock using: variableName

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its quintile (lowest values = 1; highest values = 5). The quintile value is returned as an extension to the recipient named by the supplied variableName

Type: Method Returns: List
Parameters:
1 - Block
2 - String

rankCorrelate:with:

Synopsis:
Collection rankCorrelate: blockX with: blockY

Description:
Computes the correlation between the relative ranks of the data items defined by the two blocks.

Type: Method Returns: Number
Parameters:
1 - Block
2 - Block

rankDown:

Synopsis:
Collection rankDown: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its rank (highest value = 1). Returns the recipient list extended by the property 'rank'.

Type: Method Returns: List
Parameters:
1 - Block

rankDown:by:

Synopsis:
Collection rankDown: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a rank value for each element relative to its group. The result object is the original collection extended by the variable 'rank'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

rankDown:by:by:

Synopsis:
Collection rankDown: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a rank value for each element relative to its group. The result object is the original collection extended by the variable 'rank'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

rankDown:usingCollector:

Synopsis:
Collection rankDown: block1 usingCollector: block2

Description:
Ranks down the recipient List based on the criteria specified by block1. The second block provides the name of the extension.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block

rankUp:

Synopsis:
Collection rankUp: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its rank (lowest value = 1). Returns a copy of the recipient list extended by the property 'rank'.

Type: Method Returns: List
Parameters:
1 - Block

rankUp:by:

Synopsis:
Collection rankUp: aBlock by: bBlock

Description:
Groups the recipient by the criteria in bBlock and generates a rank value for each element relative to its group. The result object is the original collection extended by the variable 'rank'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

rankUp:by:by:

Synopsis:
Collection rankUp: aBlock by: bBlock by: cBlock

Description:
Groups the recipient by the criteria in bBlock and cBlock and generates a rank value for each element relative to its group. The result object is the original collection extended by the variable 'rank'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Block

rankUp:usingCollector:

Synopsis:
Collection rankUp: block1 usingCollector: block2

Description:
Ranks up the recipient List based on the criteria specified by block1. The second block provides the name of the extension.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block

regress:

Synopsis:
Collection regress: list2

Description:
Performs a standard linear regression between the recipient collection
(the dependent variable) and the supplied parameter (the independent
variable). The returned object responds to the messages 'beta', 'alpha',
'pearson', 'rsq', and 'stdErr'. If either collection contains non-numeric
values or the two collections are not the same size, the returned values will
be NA. For example:

(2,3,9,1,8,7,5) regress: (6,5,11,7,5,4,4) .
do: [ beta print ; alpha print ;
pearson print ; rsq print ; stdErr printNL ;
] ;

runs the regression and displays the results of the various computations.

Type: Method Returns: Object
Parameters:
1 - Collection

runningAverage:

Synopsis:
Collection runningAverage: aBlock

Description:
Extends each element in the list by the variable 'runningAverage' which is the computed running average for the element based on the supplied block.

Type: Method Returns: List
Parameters:
1 - Block

runningTotal:

Synopsis:
Collection runningTotal: aBlock

Description:
Computes the running total for each element in the list based on the supplied block.

Type: Method Returns: List
Parameters:
1 - Block

runningTotal:usingCollector:

Synopsis:
Collection runningTotal: block1 usingCollector: block2

Description:
Computes the running total for the recipient timeSeries based on the criteria specified by block1. The second block provides the name of the extension.

Type: Method Returns: TimeSeries
Parameters:
1 - Block
2 - Block

select:

Synopsis:
TimeSeries select: aBlock

Description:
Evaluates the statements provided in supplied block for each point in the time series and selects those elements that evaluate to TRUE.

Type: Primitive Returns: TimeSeries
Parameters:
1 - Block

Also Defined At:
| IndexedList | List |

send:

Synopsis:
TimeSeries send: aBlock

Description:
Returns a time series that contains the result of evaluating the statements provided in supplied block for each element in the recipient.

Type: Primitive Returns: TimeSeries
Parameters:
1 - Block

Also Defined At:
| IndexedList | List | Object |

send:with:

Synopsis:
Collection send: aBlock with: aValue

Description:
Sends the block to each element of the recipient. The block is evaluated with aValue as a parameter

Type: Method Returns: List
Parameters:
1 - Block
2 - Object

Also Defined At:
| Object |

sortDown:

Synopsis:
Collection sortDown: aBlock

Description:
Evaluates the statements provided in the supplied block and sorts the list in descending order. Sort is highest to lowest for numbers. Sort is ZZZ through A for strings.

Type: Method Returns: List
Parameters:
1 - Block

sortDownBy:then:

Synopsis:
Collection sortDownBy: block1 then: block2

Description:
Two-level descending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block

sortDownBy:then:then:

Synopsis:
Collection sortDownBy: block1 then: block2 then: block3

Description:
Three-level descending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Block

sortDownBy:then:then:then:

Synopsis:
Collection sortDownBy: block1 then: block2 then: block3 then: block4

Description:
Four-level descending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Block
4 - Block

sortUp:

Synopsis:
Collection sortUp: aBlock

Description:
Evaluates the statements provided in the supplied block and sorts the list in ascending order. Sort is lowest to highest for numbers. Sort is A through Z for strings.

Type: Method Returns: List
Parameters:
1 - Block

sortUpBy:then:

Synopsis:
Collection sortUpBy: block1 then: block2

Description:
Two-level ascending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block

sortUpBy:then:then:

Synopsis:
Collection sortUpBy: block1 then: block2 then: block3

Description:
Three-level ascending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Block

sortUpBy:then:then:then:

Synopsis:
Collection sortUpBy: block1 then: block2 then: block3 then: block4

Description:
Four-level ascending sort.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Block
4 - Block

standardize

Synopsis:
Collection standardize

Description:
Strips off one layer of extension from recipient.

Type: Method Returns: List

stdDev

Synopsis:
Collection stdDev

Description:
Computes the standard deviation of the values in the recipient time series.

Type: Method Returns: Number

stdDev:

Synopsis:
Collection stdDev: aBlock

Description:
Evaluates the formula provided in aBlock for each element in the list and computes the standard deviation of the values.

Type: Method Returns: Number
Parameters:
1 - Block

stdDevForDateRange:

Synopsis:
TimeSeries stdDevForDateRange: aDateRange

Description:
Computes the standard deviation of the values in the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

tileDown:tiles:

Synopsis:
Collection tileDown: block1 tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block1; extends recipient by its tile value with the extension 'tile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Number

tileDown:using:tiles:

Synopsis:
Collection tileDown: block using: variableName tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block; extends recipient by its tile value with the extension being named by the string provided in variableName.

Type: Method Returns: List
Parameters:
1 - Block
2 - String
3 - Number

tileDown:usingCollector:tiles:

Synopsis:
Collection tileDown: block1 usingCollector: block2 tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block1; extends recipient by its tile value with the extension being named by the collector provided in block2.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Number

tileUp:tiles:

Synopsis:
Collection tileUp: block1 tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block1; extends recipient by its tile value with the extension 'tile'.

Type: Method Returns: Collection
Parameters:
1 - Block
2 - Number

tileUp:using:tiles:

Synopsis:
Collection tileUp: block using: variableName tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block; extends recipient by its tile value with the extension being named by the string provided in variableName.

Type: Method Returns: List
Parameters:
1 - Block
2 - String
3 - Number

tileUp:usingCollector:tiles:

Synopsis:
Collection tileUp: block1 usingCollector: block2 tiles: aNumber

Description:
Divides recipient list into number of tiles specified based on criteria provided in block1; extends recipient by its tile value with the extension being named by the collector provided in block2.

Type: Method Returns: List
Parameters:
1 - Block
2 - Block
3 - Number

to:

Synopsis:
TimeSeries to: date1

Description:
Returns the subset of points in the recipient on or before the supplied date.

Type: Method Returns: TimeSeries
Parameters:
1 - Date

Also Defined At:
| String |

toList

Synopsis:
TimeSeries toList

Description:
Converts a TimeSeries into a standard List.

Type: Primitive Returns: List
Also Defined At:
| IndexedList | List | String |

total

Synopsis:
Collection total

Description:
Computes the sum for the collection assuming the collection contains numeric values.

Type: Method Returns: Number

total:

Synopsis:
Collection total: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes the total value.

Type: Method Returns: Number
Parameters:
1 - Block

totalForDateRange:

Synopsis:
TimeSeries totalForDateRange: aDateRange

Description:
Computes the total of the values in the recipient time series over the specified date range.

Type: Method Returns: Number
Parameters:
1 - DateRange

Also Defined At:
| Block |

union:

Synopsis:
Collection union: aList

Description:
Finds the elements that are in EITHER or BOTH the recipient list and aList. Only unique elements are returned.

Type: Method Returns: List
Parameters:
1 - List

union:using:

Synopsis:
Collection union: aList using: aBlock

Description:
Finds union of elements in aList and recipient using rules supplied by block to strip any extensions from elements before comparing for equality.

Type: Method Returns: List
Parameters:
1 - List
2 - Block

unique

Synopsis:
Collection unique

Description:
Finds the unique elements in the list.

Type: Method Returns: List

updateWith:

Synopsis:
TimeSeries updateWith: anObject

Description:
Adds a new point to the time series as of the current evaluation date if the supplied value is different from the current value. If the time series has an NA or Default value as of the earliest possible date and this update supplies the first 'real' point in the time series, the value will be stored as of earliest possible date as well.

Type: Method Returns: TimeSeries
Parameters:
1 - Object

value

Synopsis:
TimeSeries value

Description:
Evaluates the time series as of the default date.

Type: Primitive Returns: Object
Also Defined At:
| Block | Object |

valueCell

Synopsis:
TimeSeries valueCell

Type: Primitive Returns: Object

valueCell:

Synopsis:
TimeSeries valueCell: aDate

Type: Method Returns: Object
Parameters:
1 - Undefined

Also Defined At:
| IndexedList |

weightedDecile:

Synopsis:
Collection weightedDecile: aBlock

Description:
Evaluates the formula provided in aBlock for each element in the list and computes its weighted decile (lowest values = 1; highest values = 10). The result is each decile contains approximately the same total value for the block provided. The recipient list is returned sorted from lowest to highest based on supplied Block.

Type: Method Returns: List
Parameters:
1 - Block

weightedQuintile:

Synopsis:
Collection weightedQuintile: aBlock

Description:
Evaluates the formula provided in the supplied block for each element in the list and computes its weighted quintile (lowest values = 1; highest values = 5). The result is each quintile contains approximately the same total value for the block provided. The recipient list is returned sorted from lowest to highest based on the supplied block

Type: Method Returns: List
Parameters:
1 - Block

whatAmI

Synopsis:
Function whatAmI

Description:
Returns the string 'Function'.

Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

whatAmI

Synopsis:
EnumeratedFunction whatAmI

Description:
Returns the string 'EnumeratedFunction'.

Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

whatAmI

Synopsis:
Collection whatAmI

Description:
Returns the string 'Collection'.

Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

whatAmI

Synopsis:
IndexedCollection whatAmI

Description:
Returns the string 'IndexedCollection'.

Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | TimeSeries | Undefined | Utility |

whatAmI

Synopsis:
TimeSeries whatAmI

Description:
Returns the string 'TimeSeries'.

Type: Constant Returns: String
Also Defined At:
| Block | Boolean | Classification | Collection | Currency | Date | DateOffset | DateRange | Dictionary | Entity | IndexedList | Interface | List | Number | Object | OpenVision | Schema | String | Undefined | Utility |