Number Functions
- See also: Expression Language and Function Index
The functions detailed on this page deal primarily with numbers and number manipulation.
Avg(…)
- Returns the average from a given set of numbers.
Description | Avg(value1, value2, value3, --> valueN)
|
---|---|
Examples | Avg(1,2,3,4,5,6,7,8,9)
Avg(1,2,3,4,5,6,7,8,9,x)
|
Counter(…)
- Counts upwards in specified increments.
Description | Counter(Start Value, Increment, Reset Value)
The Counter() function outputs a monotonically increasing number (more simply stated, it counts) from a start value, and each time called, increases by the increment value. It is useful for sequentially numbering fields. The Counter() function maintains an internal counter, and it resets itself to zero after five seconds of inactivity. Because Counter() continues to count, it should only be used in single-use situations such as assigning its output to some field through field value assignment, for example, =counter(). With proper care, it can be used as part of an expression in the Rename, Move & Copy tool, but see also CustomData(). It is not recommended for use in any context that continually refreshes its content, such as in a panes column, file list, or expression-based custom query. Probably the best way to understand the results is to test the first example below as an expression column in a file list, and move the mouse around over that column. |
---|---|
Examples | counter()
padnumber(counter(370, 2), 4)
counter(1,1,10)
|
Math(…)
- Evaluates a given mathematical formula.
Description | math(expression)
The Math() function performs mathematical calculations. Standard arithmetic operators are supported, as are various numerical, trigonometric, and comparative functions. Simple variables are supported, as are multiple statements.
The order of operator precedence is summarized as follows, from top to bottom:
Variables may be assigned and used by specifying a simple string of letters. Examples: math(val=2) or math(x=pow(2,3)). Multiple equations may be specified, each separated by a semicolon. Expressions are evaluated left to right. The final value of the Math() function will be the result of the right-most equation. For example, the equation math(x=4; pow(2^x)) will output 16. Note: Empty fields Fields used inside of Math() are expanded (interpolated) directly. Fields with empty values may produce incomplete Math() statements. For example, if the field [number plays] is empty, an expression such as math([number plays] + 2) would be seen by Math() as + 2. This incomplete expression would produce a syntax error. See the Additional Examples for more information. Note: Locales and Commas Special care must be taken with the Math() function and locales that use , (comma) as a decimal separator. Many Media Center fields and the return values from functions may contain comma as the decimal point. Your expressions will need to Replace() these before passing the values to Math(), which always uses dot . as the numeric decimal point. For example, the expression math(1,5 + 1,5) will fail since Math() does not consider 1,5 to be a valid number. Fields that cause problems are any fields that produce floating-point values, such as any Date type field in raw format (e.g. [date,0], [last played,0], [date modified,0], and [date imported,0]), or any textual field that contains floating-point values that will be used for various calculations (e.g. any of the Dynamic Range variants). Certain functions such as Now() and ConvertTime() also return localized floating-point values. Handling this problem is not difficult. Before passing any floating point number to Math(), use Replace() first. See the examples below. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Examples | math(10 + 4)
Returns 14. math(10 + 2 * 25) Returns 60, demonstrating that multiplication has higher precedence than addition. math((10 + 2) * 25) Returns 300, demonstrating that parenthesis grouping has higher precedence than multiplication. math(replace(now(), /,, .) - replace([last played,0], /,, .)) The , is replaced by a . in the output of both Now() and in the raw field value [last played,0]. Note that the comma must be escaped so that it is seen as an argument and not as an argument separator. math(replace(now() - [last layed,0], /,, .)) The same as the previous example, but is more efficient and simpler since it calls Replace() just once on the entire string to be passed to Math(). Additional Examples |
Max(…)
- Returns the smallest number from a given set of numbers.
Description | Max(value1, value2, value3, --> valueN)
|
---|---|
Examples | Max(1,2,3,4,5,x,y)
Max(1,2,3,4,-5)
|
Min(…)
- Returns the smallest number from a given set of numbers.
Description | Min(value1, value2, value3, --> valueN)
|
---|---|
Examples | Min(1,2,3,4,5,x,y)
Min(1,2,3,4,5)
|
Number(…)
- Returns the first number , including decimals, from a given string
Description | Number(String)
Returns the first number , including decimals, from a given string. If there are other numbers along the string, these will not be returned as the function stops once it encounters and returns the first number. String can be given literally, as a library field, or combined with other expression functions. |
---|---|
Examples | Number(The number12 will be returned, but 13 will not)
|
Rand(…)
- Returns a random number anywhere between two given numbers
Description | Rand(x, y, mode)
Available mode values:
Rand() returns a random value between x and y. x and y must be numbers and can have negative values. Rand() is not recommended for use in any context that continually refreshes its content, such as in a panes column, file list, or expression-based custom query. Probably the best way to understand the results is to test the first example below as an expression column in a file list, and move the mouse around over that column. | ||||
---|---|---|---|---|---|
Examples | Rand(0,1)
Rand(-10,10,1)
|
Range(…)
- Creates a semi-colon delimited list of numbers in a field.
Description | Range(Start, Step, Count)
The Range() function returns a list of semi-colon separated numbers into one field, starting at the Start number, incrementing by the Step number, producing Count numbers. Arguments Start and Step are optional (default to 0 Zero), and can be negative. Argument Count is required and must be positive. |
---|---|
Examples | Range(1, 1, 10)
Returns 1;2;3;4;5;6;7;8;9;10. Range(5, -1, 6) Returns 5;4;3;2;1;0. |
Roman(…)
- Converts any given number to, or from, roman numerals.
Description | Roman(Value)
Converts "Value" to or from roman numerals. |
---|---|
Examples | Roman(4)
Roman(IV)
|
StackCount(…)
- Returns the number of files in a stack
Description | StackCount()
StackCount() does not require any arguments and is used to return the number files in a stack. This is useful, for example, if you are creating custom tooltips and want that information in there or for inclusion in a view you could create to view and manage your stacks, something you might use heavily if you stack a lot of photos or regularly sync files to a handheld device using the convert format options available there. Note that some files can appear in multiple databases. |
---|---|
Examples | StackCount()
Important Note |
Sum(…)
- Returns the sum of a given set of numbers.
Description | Sum(value1, value2, value3, --> valueN)
|
---|---|
Examples | Sum(1,2,3,4,5,6,7,8,9)
Sum(1,2,3,4,5,6,7,8,9,x)
|
TrackNumber(…)
- Returns a file's track # value.
Description | tracknumber()
The TrackNumber() function returns a file's track #, or 0 if the no value exists. It is used to populate the Library field track # with its value. Either the field or TrackNumber() can be used. |
---|---|
Examples | tracknumber()
Returns the value present in the track # field. |