You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
Learn more about the statistical functions AVERAGE (AVG), MIN, MAX, COUNT.
AVERAGE (AVG)
Use this function to determine the average (arithmetic mean) of a list or collection.
The AVG function has two syntax forms: the collection form and the list form. You can use the collection form to determine the average value of all occurrences of an attribute. The list form is used to determine the average value of a set of different attributes.
Collection form syntax
AVG ( attribute )
- attribute - An attribute of any type of integer, number or date of which multiple instances can occur at runtime.
List form syntax
AVG ( [ value1 , value2 , ... ] )
- [ value1 , value2 , … ] - A list of attributes, expressions or fixed values of any type of integer, number or date. Use the square brackets to indicate that the arguments form a list of values.
Return types
- number
- currency
- percentage
- date
The function returns UNKNOWN if one or more values are UNKNOWN.
Examples
Suppose the following domain model.
| Entity.attribute | Value | Multivalued relation | Entity.attribute | Values |
|---|---|---|---|---|
Residence.appraisalValue Residence.askingPrice Residence.mortgage | € 140000 € 150000 € 142000 | hasBiddings | Bidding.amount | € 132000 € 139000 € 137500 |
| Goal | Expression | Result | Type |
|---|---|---|---|
| To determine the average amount within the appraisal value, the asking price and the mortgage | AVG ( [ Residence.appraisalValue , Residence.askingPrice , Residence.mortgage ] ) | € 144000 | Currency |
| To determine the average bidding on the current residence | AVG ( Residence.hasBiddings.amount ) | € 136166.67 | Currency |
MIN
Use this function to determine the minimum value of a list or collection.
The MIN function has two syntax forms: the collection form and the list form. You can use the collection form to determine the minimum value of all occurrences of an attribute. The list form is used to determine the minimum value of a set of different attributes.
Collection form syntax
MIN ( attribute )
- attribute - An attribute of any type of integer, number, date or string of which multiple instances can occur at runtime.
List form syntax
MIN ( [ value1 , value2 , ... ] )
- [ value1 , value2 , … ] - A list of attributes, expressions or fixed values of any type of integer, number, date or string. Use the square brackets to indicate that the arguments form a list of values.
Examples
Suppose the following domain model.
| Entity.attribute | Value | Multivalued relation | Entity.attribute | Values |
|---|---|---|---|---|
Residence.appraisalValue Residence.askingPrice Residence.mortgage | € 140000 € 150000 € 142000 | hasBiddings | Bidding.amount | € 132000 € 139000 € 137500 |
| Goal | Expression | Result | Type |
|---|---|---|---|
| To determine the smallest amount within the appraisal value, the asking price and the mortgage | MIN ( [ Residence.appraisalValue , Residence.askingPrice , Residence.mortgage ] ) | € 140000 | Currency |
| To determine the lowest bidding on the current residence | MIN ( Residence.hasBiddings.amount ) | € 132000 | Currency |
Example with strings
| Expression | Result |
|---|---|
| MIN( ["after", "action"] ) | "action" |
MAX
Use this function to determine the maximum value of a list or collection.
The MAX function has two syntax forms: the collection form and the list form. You can use the collection form to determine the maximum value of all occurrences of an attribute. The list form is used to determine the maximum value of a set of different attributes.
Collection form syntax
MAX ( attribute )
- attribute - An attribute of any type of integer, number, date or string of which multiple instances can occur at runtime.
List form syntax
MAX ( [ value1 , value2 , ... ] )
- [ value1 , value2 , … ] - A list of attributes, expressions or fixed values of any type of integer, number, date or string. Use the square brackets to indicate that the arguments form a list of values.
Examples
Suppose the following domain model.
| Entity.attribute | Value | Multivalued relation | Entity.attribute | Values |
|---|---|---|---|---|
Residence.appraisalValue Residence.askingPrice Residence.mortgage | € 140000 € 150000 € 142000 | hasBiddings | Bidding.amount | € 132000 € 139000 € 137500 |
| Goal | Expression | Result | Type |
|---|---|---|---|
| To determine the largest amount within the appraisal value, the asking price and the mortgage | MAX ( [ Residence.appraisalValue , Residence.askingPrice , Residence.mortgage ] ) | € 150000 | Currency |
| To determine the highest bidding on the current residence | MAX ( Residence.hasBiddings.amount ) | € 139000 | Currency |
Example with strings
| Expression | Result |
|---|---|
| MAX( ["after", "action"] ) | "after" |
COUNT
Use this function to retrieve the number of instances for the specified entities or attributes. Please note the similar function SIZE.
Syntax
COUNT ( collection )
- collection - A collection of attribute or entity instances.
Return type
- integer
Examples
Suppose the following data model.
| Instance | Person.name |
|---|---|
| 1 | “John” |
| 2 | “Dave” |
| 3 | “Jane” |
| 4 | “Lisa” |
| Instance | House.rooms |
|---|---|
| singleton | “living room”, “bathroom”, “bedroom” |
| Expression | Result | Type |
|---|---|---|
| COUNT ( ALL Person ) | 4 | Integer |
| COUNT ( House.rooms ) | 3 | Integer |
| COUNT ( ALL Person + ALL House ) | 5 | Integer |
| COUNT ( COLLECT Person FROM ALL Person WHERE ( Person.name = “Lisa” ) ) | 1 | Integer |
| COUNT ( ? (= UNKNOWN) ) | UNKNOWN | Integer |
SIZE and COUNT are similar except for ?:
SIZE( ? ) results in 0, while COUNT( ? ) results in ?
Overview
Content Tools