Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions | Variables

Adaptive Function to_string<template> More...

Functions

const afw_value_tafw_function_execute_in_range_time (afw_function_execute_t *x)
 Adaptive Function in_range<time> More...
 

Variables

 afw_function_definition_at_least_one_member_of_time
 Function definition at_least_one_member_of<time>
 
 afw_function_definition_bag_size_time
 Adaptive Function at_least_one_member_of<time> More...
 
 afw_function_definition_bag_time
 Adaptive Function bag_size<time> More...
 
 afw_function_definition_eq_time
 Adaptive Function bag<time> More...
 
 afw_function_definition_eqx_time
 Adaptive Function eq<time> More...
 
 afw_function_definition_ge_time
 Adaptive Function eqx<time> More...
 
 afw_function_definition_gt_time
 Adaptive Function ge<time> More...
 
 afw_function_definition_in_range_time
 Adaptive Function gt<time> More...
 
 afw_function_definition_intersection_time
 Function definition intersection<time>
 
 afw_function_definition_is_in_time
 Adaptive Function intersection<time> More...
 
 afw_function_definition_is_time
 Adaptive Function is_in<time> More...
 
 afw_function_definition_le_time
 Adaptive Function is<time> More...
 
 afw_function_definition_lt_time
 Adaptive Function le<time> More...
 
 afw_function_definition_max_time
 Adaptive Function lt<time> More...
 
 afw_function_definition_min_time
 Adaptive Function max<time> More...
 
 afw_function_definition_ne_time
 Adaptive Function min<time> More...
 
 afw_function_definition_nex_time
 Adaptive Function ne<time> More...
 
 afw_function_definition_one_and_only_time
 Adaptive Function nex<time> More...
 
 afw_function_definition_set_equals_time
 Adaptive Function one_and_only<time> More...
 
 afw_function_definition_subset_time
 Adaptive Function set_equals<time> More...
 
 afw_function_definition_time
 Adaptive Function subset<time> More...
 
 afw_function_definition_to_string_time
 Adaptive Function time More...
 
 afw_function_definition_union_time
 Adaptive Function to_string<time> More...
 

Detailed Description

Adaptive Function to_string<template>

Parameters
xfunction execute parameter.

Converts template value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_string<template>(
value: template
): string;

Parameters:

value - (template) A template value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()


time adaptive functions.

Function Documentation

◆ afw_function_execute_in_range_time()

const afw_value_t* afw_function_execute_in_range_time ( afw_function_execute_t x)

Adaptive Function in_range<time>

Parameters
xfunction execute parameter.

Checks if time is between startTime and endTime, inclusive. Regardless of endTime value, it is always considered to be equal to, but less than 24 hours greater than startTime. If no time zone is specified for time, the default time zone is used. If no time zone is specified for startTime or endTime, the time zone of time is used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function in_range<time>(
time: time,
startTime: time,
endTime: time
): boolean;

Parameters:

time - (time)

startTime - (time)

endTime - (time)

Returns:

(boolean)

Todo:
FIXME: This still doesn't feel right. Check + time zone, etc.

Definition at line 57 of file afw_function_time.c.

Variable Documentation

◆ afw_function_definition_bag_size_time

afw_function_definition_bag_size_time

Adaptive Function at_least_one_member_of<time>

Parameters
xfunction execute parameter.

Returns boolean true if at least one value in time list1 is in time list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function at_least_one_member_of<time>(
list1: (list time),
list2: (list time)
): boolean;

Parameters:

list1 - (list time) The first list.

list2 - (list time) The second list.

Returns:

(boolean)

Implemented by afw_function_execute_at_least_one_member_of()


Function definition bag_size<time>

Definition at line 29575 of file afw_function_bindings.h.

◆ afw_function_definition_bag_time

afw_function_definition_bag_time

Adaptive Function bag_size<time>

Parameters
xfunction execute parameter.

This returns the integer number of values in list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag_size<time>(
value: (list time)
): integer;

Parameters:

value - (list time)

Returns:

(integer)

Implemented by afw_function_execute_bag_size()


Function definition bag<time>

Definition at line 29609 of file afw_function_bindings.h.

◆ afw_function_definition_eq_time

afw_function_definition_eq_time

Adaptive Function bag<time>

Parameters
xfunction execute parameter.

Takes any number of time values and returns a list of list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag<time>(
...values: (list of (list time))
): (list time);

Parameters:

values - (0 or more list time)

Returns:

(list time)

Implemented by afw_function_execute_bag()


Function definition eq<time>

Definition at line 29643 of file afw_function_bindings.h.

◆ afw_function_definition_eqx_time

afw_function_definition_eqx_time

Adaptive Function eq<time>

Parameters
xfunction execute parameter.

Determine if time arg1 is equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "eqx" ("===") instead if you want false to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eq<time>(
arg1: time,
arg2: any
): boolean;

Parameters:

arg1 - (time)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_eq()


Function definition eqx<time>

Definition at line 29686 of file afw_function_bindings.h.

◆ afw_function_definition_ge_time

afw_function_definition_ge_time

Adaptive Function eqx<time>

Parameters
xfunction execute parameter.

Determine if for time arg1 is equal to the value and data type of arg2 then return the boolean result. Use "eq" ("==") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eqx<time>(
arg1: time,
arg2: any
): boolean;

Parameters:

arg1 - (time)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_eqx()


Function definition ge<time>

Definition at line 29725 of file afw_function_bindings.h.

◆ afw_function_definition_gt_time

afw_function_definition_gt_time

Adaptive Function ge<time>

Parameters
xfunction execute parameter.

Checks for time arg1 is greater than or equal to time arg2 and return the boolean result.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ge<time>(
arg1: time,
arg2: time
): boolean;

Parameters:

arg1 - (time)

arg2 - (time)

Returns:

(boolean)

Implemented by afw_function_execute_ge()


Function definition gt<time>

Definition at line 29766 of file afw_function_bindings.h.

◆ afw_function_definition_in_range_time

afw_function_definition_in_range_time

Adaptive Function gt<time>

Parameters
xfunction execute parameter.

Checks for time arg1 is greater than time arg2 and return the boolean result.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function gt<time>(
arg1: time,
arg2: time
): boolean;

Parameters:

arg1 - (time)

arg2 - (time)

Returns:

(boolean)

Implemented by afw_function_execute_gt()


Function definition in_range<time>

Definition at line 29807 of file afw_function_bindings.h.

◆ afw_function_definition_is_in_time

afw_function_definition_is_in_time

Adaptive Function intersection<time>

Parameters
xfunction execute parameter.

Returns a list of time with the values that are common to both list of time list1 and list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function intersection<time>(
list1: (list time),
list2: (list time)
): (list time);

Parameters:

list1 - (list time) The first list.

list2 - (list time) The second list.

Returns:

(list time)

Implemented by afw_function_execute_intersection()


Function definition is_in<time>

Definition at line 29888 of file afw_function_bindings.h.

◆ afw_function_definition_is_time

afw_function_definition_is_time

Adaptive Function is_in<time>

Parameters
xfunction execute parameter.

Checks whether time value is in list of time list and returns the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function is_in<time>(
value: time,
list: (list time)
): boolean;

Parameters:

value - (time)

list - (list time)

Returns:

(boolean)

Implemented by afw_function_execute_is_in()


Function definition is<time>

Definition at line 29926 of file afw_function_bindings.h.

◆ afw_function_definition_le_time

afw_function_definition_le_time

Adaptive Function is<time>

Parameters
xfunction execute parameter.

Checks whether value is dataType time and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function is<time>(
value: any
): boolean;

Parameters:

value - (any dataType) Value to check.

Returns:

(boolean)

Implemented by afw_function_execute_is()


Function definition le<time>

Definition at line 29960 of file afw_function_bindings.h.

◆ afw_function_definition_lt_time

afw_function_definition_lt_time

Adaptive Function le<time>

Parameters
xfunction execute parameter.

Checks for time arg1 is less than or equal to time arg2 and return the boolean result.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function le<time>(
arg1: time,
arg2: any
): boolean;

Parameters:

arg1 - (time)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_le()


Function definition lt<time>

Definition at line 30001 of file afw_function_bindings.h.

◆ afw_function_definition_max_time

afw_function_definition_max_time

Adaptive Function lt<time>

Parameters
xfunction execute parameter.

Checks for time arg1 is less that time arg2 and return the boolean result.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function lt<time>(
arg1: time,
arg2: time
): boolean;

Parameters:

arg1 - (time)

arg2 - (time)

Returns:

(boolean)

Implemented by afw_function_execute_lt()


Function definition max<time>

Definition at line 30041 of file afw_function_bindings.h.

◆ afw_function_definition_min_time

afw_function_definition_min_time

Adaptive Function max<time>

Parameters
xfunction execute parameter.

Return the time value that is greater than or equal to the others.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function max<time>(
values_1: time,
...values_rest: (list of time)
): time;

Parameters:

values - (1 or more time)

Returns:

(time)

Implemented by afw_function_execute_max()


Function definition min<time>

Definition at line 30079 of file afw_function_bindings.h.

◆ afw_function_definition_ne_time

afw_function_definition_ne_time

Adaptive Function min<time>

Parameters
xfunction execute parameter.

Return the time value that is less than or equal to the others.

It is illegal to compare a time that includes a time-zone value with one that does not. In such cases, the in_range<time> function should be used.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function min<time>(
values_1: time,
...values_rest: (list of time)
): time;

Parameters:

values - (1 or more time)

Returns:

(time)

Implemented by afw_function_execute_min()


Function definition ne<time>

Definition at line 30117 of file afw_function_bindings.h.

◆ afw_function_definition_nex_time

afw_function_definition_nex_time

Adaptive Function ne<time>

Parameters
xfunction execute parameter.

Determine if time arg1 is not equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "nex" ("!==") instead if you want true to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ne<time>(
arg1: time,
arg2: any
): boolean;

Parameters:

arg1 - (time)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_ne()


Function definition nex<time>

Definition at line 30160 of file afw_function_bindings.h.

◆ afw_function_definition_one_and_only_time

afw_function_definition_one_and_only_time

Adaptive Function nex<time>

Parameters
xfunction execute parameter.

Determine if for time arg1 is not equal to the value or data type of arg2 then return the boolean result. Use "ne" ("!=") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function nex<time>(
arg1: time,
arg2: any
): boolean;

Parameters:

arg1 - (time)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_nex()


Function definition one_and_only<time>

Definition at line 30199 of file afw_function_bindings.h.

◆ afw_function_definition_set_equals_time

afw_function_definition_set_equals_time

Adaptive Function one_and_only<time>

Parameters
xfunction execute parameter.

This converts a list of time values that contains one value to a single time value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function one_and_only<time>(
list: (list list)
): time;

Parameters:

list - (list list)

Returns:

(time)

Errors thrown:

arg_error - list does not contain exactly one value

Implemented by afw_function_execute_one_and_only()


Function definition set_equals<time>

Definition at line 30238 of file afw_function_bindings.h.

◆ afw_function_definition_subset_time

afw_function_definition_subset_time

Adaptive Function set_equals<time>

Parameters
xfunction execute parameter.

Returns boolean true if time list1 and time list2 are subsets of each other and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function set_equals<time>(
list1: (list time),
list2: (list time)
): boolean;

Parameters:

list1 - (list time)

list2 - (list time)

Returns:

(boolean)

Implemented by afw_function_execute_set_equals()


Function definition subset<time>

Definition at line 30276 of file afw_function_bindings.h.

◆ afw_function_definition_time

afw_function_definition_time

Adaptive Function subset<time>

Parameters
xfunction execute parameter.

Returns boolean true if the unique values in time list1 are all in time list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function subset<time>(
list1: (list time),
list2: (list time)
): boolean;

Parameters:

list1 - (list time) The first list.

list2 - (list time) The second list.

Returns:

(boolean)

Implemented by afw_function_execute_subset()


Function definition time

Definition at line 30314 of file afw_function_bindings.h.

◆ afw_function_definition_to_string_time

afw_function_definition_to_string_time

Adaptive Function time

Parameters
xfunction execute parameter.

Converts value to data type time returning time result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function time(
value: any
): time;

Parameters:

value - (any dataType) Value to convert.

Returns:

(time) Converted value.

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_string<time>

Definition at line 30352 of file afw_function_bindings.h.

◆ afw_function_definition_union_time

afw_function_definition_union_time

Adaptive Function to_string<time>

Parameters
xfunction execute parameter.

Converts time value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_string<time>(
value: time
): string;

Parameters:

value - (time) A time value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()


Function definition union<time>

Definition at line 30387 of file afw_function_bindings.h.