Operators (N to R)
This file is automatically generated from java files. Do Not Edit It.
Definition​
Operators in the GAML language are used to compose complex expressions. An operator performs a function on one, two, or n operands (which are other expressions and thus may be themselves composed of operators) and returns the result of this function.
Most of them use a classical prefixed functional syntax (i.e. operator_name(operand1, operand2, operand3)
, see below), with the exception of arithmetic (e.g. +
, /
), logical (and
, or
), comparison (e.g. >
, <
), access (.
, [..]
) and pair (::
) operators, which require an infixed notation (i.e. operand1 operator_symbol operand1
).
The ternary functional if-else operator, ? :
, uses a special infixed syntax composed with two symbols (e.g. operand1 ? operand2 : operand3
). Two unary operators (-
and !
) use a traditional prefixed syntax that does not require parentheses unless the operand is itself a complex expression (e.g. - 10
, ! (operand1 or operand2)
).
Finally, special constructor operators ({...}
for constructing points, [...]
for constructing lists and maps) will require their operands to be placed between their two symbols (e.g. {1,2,3}
, [operand1, operand2, ..., operandn]
or [key1::value1, key2::value2... keyn::valuen]
).
With the exception of these special cases above, the following rules apply to the syntax of operators:
- if they only have one operand, the functional prefixed syntax is mandatory (e.g.
operator_name(operand1)
) - if they have two arguments, either the functional prefixed syntax (e.g.
operator_name(operand1, operand2)
) or the infixed syntax (e.g.operand1 operator_name operand2
) can be used. - if they have more than two arguments, either the functional prefixed syntax (e.g.
operator_name(operand1, operand2, ..., operand)
) or a special infixed syntax with the first operand on the left-hand side of the operator name (e.g.operand1 operator_name(operand2, ..., operand)
) can be used.
All of these alternative syntaxes are completely equivalent.
Operators in GAML are purely functional, i.e. they are guaranteed to not have any side effects on their operands. For instance, the shuffle
operator, which randomizes the positions of elements in a list, does not modify its list operand but returns a new shuffled list.
Priority between operators​
The priority of operators determines, in the case of complex expressions composed of several operators, which one(s) will be evaluated first.
GAML follows in general the traditional priorities attributed to arithmetic, boolean, comparison operators, with some twists. Namely:
- the constructor operators, like
::
, used to compose pairs of operands, have the lowest priority of all operators (e.g.a > b :: b > c
will return a pair of boolean values, which means that the two comparisons are evaluated before the operator applies. Similarly,[a > 10, b > 5]
will return a list of boolean values. - it is followed by the
?:
operator, the functional if-else (e.g.a > b ? a + 10 : a - 10
will return the result of the if-else). - next are the logical operators,
and
andor
(e.g.a > b or b > c
will return the value of the test) - next are the comparison operators (i.e.
>
,<
,<=
,>=
,=
,!=
) - next the arithmetic operators in their logical order (multiplicative operators have a higher priority than additive operators)
- next the unary operators
-
and!
- next the access operators
.
and[]
(e.g.{1,2,3}.x > 20 + {4,5,6}.y
will return the result of the comparison between the x and y ordinates of the two points) - and finally the functional operators, which have the highest priority of all.
Using actions as operators​
Actions defined in species can be used as operators, provided they are called on the correct agent. The syntax is that of normal functional operators, but the agent that will perform the action must be added as the first operand.
For instance, if the following species is defined:
species spec1 {
int min(int x, int y) {
return x > y ? x : y;
}
}
Any agent instance of spec1 can use min
as an operator (if the action conflicts with an existing operator, a warning will be emitted). For instance, in the same model, the following line is perfectly acceptable:
global {
init {
create spec1;
spec1 my_agent <- spec1[0];
int the_min <- my_agent min(10,20); // or min(my_agent, 10, 20);
}
}
If the action doesn't have any operands, the syntax to use is my_agent the_action()
. Finally, if it does not return a value, it might still be used but is considering as returning a value of type unknown
(e.g. unknown result <- my_agent the_action(op1, op2);
).
Note that due to the fact that actions are written by modelers, the general functional contract is not respected in that case: actions might perfectly have side effects on their operands (including the agent).
Table of Contents​
Operators by categories​
3D​
box, cone3D, cube, cylinder, hexagon, pyramid, set_z, sphere, teapot,
Arithmetic operators​
-, /, ^, *, +, abs, acos, asin, atan, atan2, ceil, cos, cos_rad, div, even, exp, fact, floor, hypot, is_finite, is_number, ln, log, mod, round, signum, sin, sin_rad, sqrt, tan, tan_rad, tanh, with_precision,
BDI​
add_values, and, eval_when, get_about, get_agent, get_agent_cause, get_belief_op, get_belief_with_name_op, get_beliefs_op, get_beliefs_with_name_op, get_current_intention_op, get_decay, get_desire_op, get_desire_with_name_op, get_desires_op, get_desires_with_name_op, get_dominance, get_familiarity, get_ideal_op, get_ideal_with_name_op, get_ideals_op, get_ideals_with_name_op, get_intensity, get_intention_op, get_intention_with_name_op, get_intentions_op, get_intentions_with_name_op, get_lifetime, get_liking, get_modality, get_obligation_op, get_obligation_with_name_op, get_obligations_op, get_obligations_with_name_op, get_plan_name, get_predicate, get_solidarity, get_strength, get_super_intention, get_trust, get_truth, get_uncertainties_op, get_uncertainties_with_name_op, get_uncertainty_op, get_uncertainty_with_name_op, get_values, has_belief_op, has_belief_with_name_op, has_desire_op, has_desire_with_name_op, has_ideal_op, has_ideal_with_name_op, has_intention_op, has_intention_with_name_op, has_obligation_op, has_obligation_with_name_op, has_uncertainty_op, has_uncertainty_with_name_op, new_emotion, new_mental_state, new_predicate, new_social_link, not, or, set_about, set_agent, set_agent_cause, set_decay, set_dominance, set_familiarity, set_intensity, set_lifetime, set_liking, set_modality, set_predicate, set_solidarity, set_strength, set_trust, set_truth, with_values,
Casting operators​
as, as_int, as_matrix, field_with, font, is, is_skill, list_with, matrix_with, species_of, to_gaml, to_geojson, to_list, with_size, with_style,
Color-related operators​
-, /, *, +, blend, brewer_colors, brewer_palettes, gradient, grayscale, hsb, mean, median, palette, rgb, rnd_color, scale, sum, to_hsb,
Comparison operators​
Containers-related operators​
-, ::, +, accumulate, all_match, among, as_json_string, at, cartesian_product, collect, contains, contains_all, contains_any, contains_key, count, empty, every, first, first_with, get, group_by, in, index_by, inter, interleave, internal_integrated_value, last, last_with, length, max, max_of, mean, mean_of, median, min, min_of, mul, none_matches, one_matches, one_of, product_of, range, remove_duplicates, reverse, shuffle, sort_by, split, split_in, split_using, sum, sum_of, union, variance_of, where, with_max_of, with_min_of,
Date-related operators​
-, !=, +, <, <=, =, >, >=, after, before, between, every, milliseconds_between, minus_days, minus_hours, minus_minutes, minus_months, minus_ms, minus_weeks, minus_years, months_between, plus_days, plus_hours, plus_minutes, plus_months, plus_ms, plus_weeks, plus_years, since, to, until, years_between,
Dates​
Displays​
edge​
EDP-related operators​
Files-related operators​
agent_file, copy_file, crs, csv_file, delete_file, dxf_file, evaluate_sub_model, file_exists, folder, folder_exists, gaml_file, geojson_file, get, gif_file, gml_file, graph6_file, graphdimacs_file, graphdot_file, graphgexf_file, graphgml_file, graphml_file, graphtsplib_file, grid_file, image_file, is_agent, is_csv, is_dxf, is_gaml, is_geojson, is_gif, is_gml, is_graph6, is_graphdimacs, is_graphdot, is_graphgexf, is_graphgml, is_graphml, is_graphtsplib, is_grid, is_image, is_json, is_obj, is_osm, is_pgm, is_property, is_shape, is_simulation, is_svg, is_text, is_threeds, is_xml, json_file, new_folder, obj_file, osm_file, pgm_file, property_file, read, rename_file, shape_file, simulation_file, step_sub_model, svg_file, text_file, threeds_file, unzip, writable, xml_file, zip,
GamaMetaType​
GamaSVGFile​
Graphs-related operators​
add_edge, add_node, adjacency, agent_from_geometry, all_pairs_shortest_path, alpha_index, as_distance_graph, as_edge_graph, as_intersection_graph, as_path, as_spatial_graph, beta_index, betweenness_centrality, biggest_cliques_of, connected_components_of, connectivity_index, contains_edge, contains_vertex, degree_of, directed, edge, edge_between, edge_betweenness, edges, gamma_index, generate_barabasi_albert, generate_complete_graph, generate_random_graph, generate_watts_strogatz, girvan_newman_clustering, grid_cells_to_graph, in_degree_of, in_edges_of, k_spanning_tree_clustering, label_propagation_clustering, layout_circle, layout_force, layout_force_FR, layout_force_FR_indexed, layout_grid, load_shortest_paths, main_connected_component, max_flow_between, maximal_cliques_of, nb_cycles, neighbors_of, node, nodes, out_degree_of, out_edges_of, path_between, paths_between, predecessors_of, remove_node_from, rewire_n, source_of, spatial_graph, strahler, successors_of, sum, target_of, undirected, use_cache, weight_of, with_k_shortest_path_algorithm, with_shortest_path_algorithm, with_weights,
Grid-related operators​
as_4_grid, as_grid, as_hexagonal_grid, cell_at, cells_in, cells_overlapping, field, grid_at, neighbors_of, path_between, points_in, values_in,
ImageOperators​
*, antialiased, blend, blurred, brighter, clipped_with, darker, grayscale, horizontal_flip, image, matrix, rotated_by, sharpened, snapshot, tinted_with, vertical_flip, with_height, with_size, with_width,
Iterator operators​
accumulate, all_match, as_map, collect, count, create_map, first_with, frequency_of, group_by, index_by, last_with, max_of, mean_of, min_of, none_matches, one_matches, product_of, sort_by, sum_of, variance_of, where, where, where, with_max_of, with_min_of,
List-related operators​
all_indexes_of, copy_between, index_of, last_index_of,
Logical operators​
:, !, ?, add_3Dmodel, add_geometry, add_icon, and, or, xor,
Map comparaison operators​
fuzzy_kappa, fuzzy_kappa_sim, kappa, kappa_sim, percent_absolute_deviation,
Map-related operators​
as_map, create_map, index_of, last_index_of,
Matrix-related operators​
-, /, ., *, +, append_horizontally, append_vertically, column_at, columns_list, determinant, eigenvalues, flatten, index_of, inverse, last_index_of, row_at, rows_list, shuffle, trace, transpose,
multicriteria operators​
electre_DM, evidence_theory_DM, fuzzy_choquet_DM, promethee_DM, weighted_means_DM,
Path-related operators​
agent_from_geometry, all_pairs_shortest_path, as_path, load_shortest_paths, max_flow_between, path_between, path_to, paths_between, use_cache,
Pedestrian​
Points-related operators​
-, /, *, +, <, <=, >, >=, add_point, angle_between, any_location_in, centroid, closest_points_with, farthest_point_to, grid_at, norm, points_along, points_at, points_on,
Random operators​
binomial, exp_density, exp_rnd, flip, gamma_density, gamma_rnd, gamma_trunc_rnd, gauss, generate_terrain, lognormal_density, lognormal_rnd, lognormal_trunc_rnd, poisson, rnd, rnd_choice, sample, shuffle, skew_gauss, truncated_gauss, weibull_density, weibull_rnd, weibull_trunc_rnd,
ReverseOperators​
Shape​
arc, box, circle, cone, cone3D, cross, cube, curve, cylinder, ellipse, elliptical_arc, envelope, geometry_collection, hexagon, line, link, plan, polygon, polyhedron, pyramid, rectangle, sphere, square, squircle, teapot, triangle,
Spatial operators​
-, *, +, add_point, agent_closest_to, agent_farthest_to, agents_at_distance, agents_covering, agents_crossing, agents_inside, agents_overlapping, agents_partially_overlapping, agents_touching, angle_between, any_location_in, arc, around, as_4_grid, as_driving_graph, as_grid, as_hexagonal_grid, at_distance, at_location, box, centroid, circle, clean, clean_network, closest_points_with, closest_to, cone, cone3D, convex_hull, covering, covers, cross, crosses, crossing, crs, CRS_transform, cube, curve, cylinder, direction_between, disjoint_from, distance_between, distance_to, ellipse, elliptical_arc, envelope, farthest_point_to, farthest_to, geometry_collection, gini, hexagon, hierarchical_clustering, IDW, inside, inter, intersects, inverse_rotation, k_nearest_neighbors, line, link, masked_by, moran, neighbors_at, neighbors_of, normalized_rotation, overlapping, overlaps, partially_overlapping, partially_overlaps, path_between, path_to, plan, points_along, points_at, points_on, polygon, polyhedron, pyramid, rectangle, rotated_by, rotation_composition, round, scaled_to, set_z, simple_clustering_by_distance, simplification, skeletonize, smooth, sphere, split_at, split_geometry, split_lines, square, squircle, teapot, to_GAMA_CRS, to_rectangles, to_segments, to_squares, to_sub_geometries, touches, touching, towards, transformed_by, translated_by, triangle, triangulate, union, using, voronoi, with_precision, without_holes,
Spatial properties operators​
covers, crosses, intersects, partially_overlaps, touches,
Spatial queries operators​
agent_closest_to, agent_farthest_to, agents_at_distance, agents_covering, agents_crossing, agents_inside, agents_overlapping, agents_partially_overlapping, agents_touching, at_distance, closest_to, covering, crossing, farthest_to, inside, neighbors_at, neighbors_of, overlapping, partially_overlapping, touching,
Spatial relations operators​
direction_between, distance_between, distance_to, path_between, path_to, towards,
Spatial statistical operators​
hierarchical_clustering, k_nearest_neighbors, simple_clustering_by_distance,
Spatial transformations operators​
-, *, +, as_4_grid, as_grid, as_hexagonal_grid, at_location, clean, clean_network, convex_hull, CRS_transform, inverse_rotation, normalized_rotation, rotated_by, rotation_composition, scaled_to, simplification, skeletonize, smooth, split_geometry, split_lines, to_GAMA_CRS, to_rectangles, to_segments, to_squares, to_sub_geometries, transformed_by, translated_by, triangulate, voronoi, with_precision, without_holes,
Species-related operators​
index_of, last_index_of, of_generic_species, of_species,
Statistical operators​
auto_correlation, beta, binomial_coeff, binomial_complemented, binomial_sum, build, chi_square, chi_square_complemented, correlation, covariance, dbscan, distribution_of, distribution2d_of, dtw, durbin_watson, frequency_of, gamma, gamma_distribution, gamma_distribution_complemented, geometric_mean, gini, harmonic_mean, hierarchical_clustering, incomplete_beta, incomplete_gamma, incomplete_gamma_complement, k_nearest_neighbors, kmeans, kurtosis, log_gamma, max, mean, mean_deviation, median, min, moment, moran, morrisAnalysis, mul, normal_area, normal_density, normal_inverse, predict, pValue_for_fStat, pValue_for_tStat, quantile, quantile_inverse, rank_interpolated, residuals, rms, rSquare, simple_clustering_by_distance, skewness, sobolAnalysis, split, split_in, split_using, standard_deviation, student_area, student_t_inverse, sum, t_test, variance,
Strings-related operators​
+, <, <=, >, >=, at, capitalize, char, contains, contains_all, contains_any, copy_between, date, empty, first, in, indented_by, index_of, is_number, last, last_index_of, length, lower_case, regex_matches, replace, replace_regex, reverse, sample, shuffle, split_with, string, upper_case,
SubModel​
System​
., choose, command, copy, copy_from_clipboard, copy_to_clipboard, copy_to_clipboard, dead, enter, eval_gaml, every, is_error, is_reachable, is_warning, play_sound, user_confirm, user_input_dialog, wizard, wizard_page,
Time-related operators​
Types-related operators​
action, agent, attributes, BDIPlan, bool, container, conversation, directory, emotion, file, float, gaml_type, geometry, graph, int, kml, list, map, matrix, mental_state, message, Norm, pair, path, point, predicate, regression, rgb, Sanction, skill, social_link, species, topology, unknown,
User control operators​
choose, enter, user_confirm, user_input_dialog, wizard, wizard_page,
Operators​
nb_cycles
​
Possible uses:​
nb_cycles
(graph
) --->int
Result:​
returns the maximum number of independent cycles in a graph. This number (u) is estimated through the number of nodes (v), links (e) and of sub-graphs (p): u = e - v + p.
Examples:​
graph graphEpidemio <- graph([]);
int var1 <- nb_cycles(graphEpidemio); // var1 equals the number of cycles in the graph
See also: alpha_index, beta_index, gamma_index, connectivity_index,
neighbors_at
​
Possible uses:​
geometry
neighbors_at
float
--->list
neighbors_at
(geometry
,float
) --->list
Result:​
a list, containing all the agents of the same species than the left argument (if it is an agent) located at a distance inferior or equal to the right-hand operand to the left-hand operand (geometry, agent, point).
Comment:​
The topology used to compute the neighborhood is the one of the left-operand if this one is an agent; otherwise the one of the agent applying the operator.
Examples:​
list var0 <- (self neighbors_at (10)); // var0 equals all the agents located at a distance lower or equal to 10 to the agent applying the operator.
See also: neighbors_of, closest_to, overlapping, agents_overlapping, agents_inside, agent_closest_to, at_distance,
neighbors_of
​
Possible uses:​
field
neighbors_of
point
--->list<point>
neighbors_of
(field
,point
) --->list<point>
graph
neighbors_of
unknown
--->list
neighbors_of
(graph
,unknown
) --->list
topology
neighbors_of
agent
--->list
neighbors_of
(topology
,agent
) --->list
neighbors_of
(topology
,geometry
,float
) --->list
Result:​
a list, containing all the agents of the same species than the argument (if it is an agent) located at a distance inferior or equal to 1 to the right-hand operand agent considering the left-hand operand topology.
Special cases:​
- a list, containing all the agents of the same species than the left argument (if it is an agent) located at a distance inferior or equal to the third argument to the second argument (agent, geometry or point) considering the first operand topology.
list var0 <- neighbors_of (topology(self), self,10); // var0 equals all the agents located at a distance lower or equal to 10 to the agent applying the operator considering its topology.
Examples:​
list var1 <- graphEpidemio neighbors_of (node(3)); // var1 equals [node0,node2]
list var2 <- graphFromMap neighbors_of node({12,45}); // var2 equals [{1.0,5.0},{34.0,56.0}]
list var3 <- topology(self) neighbors_of self; // var3 equals returns all the agents located at a distance lower or equal to 1 to the agent applying the operator considering its topology.
See also: predecessors_of, successors_of, neighbors_at, closest_to, overlapping, agents_overlapping, agents_inside, agent_closest_to,
new_emotion
​
Possible uses:​
new_emotion
(string
) --->emotion
string
new_emotion
predicate
--->emotion
new_emotion
(string
,predicate
) --->emotion
string
new_emotion
float
--->emotion
new_emotion
(string
,float
) --->emotion
string
new_emotion
agent
--->emotion
new_emotion
(string
,agent
) --->emotion
new_emotion
(string
,float
,agent
) --->emotion
new_emotion
(string
,float
,float
) --->emotion
new_emotion
(string
,predicate
,agent
) --->emotion
new_emotion
(string
,float
,predicate
) --->emotion
new_emotion
(string
,float
,predicate
,agent
) --->emotion
new_emotion
(string
,float
,float
,agent
) --->emotion
new_emotion
(string
,float
,predicate
,float
) --->emotion
new_emotion
(string
,float
,predicate
,float
,agent
) --->emotion
Result:​
a new emotion with the given properties (at least its name, and eventually intensity, parameters...)
Special cases:​
- a new emotion with a given name and the predicate it is about
new_emotion("joy",estFood)
new_emotion("joy",agent1)
- A decay value value can be added to define a new emotion.
new_emotion("joy",12.3,4.0)
- a new emotion with a name and an initial intensity:
new_emotion("joy",12.3)
- a new emotion with a given name and the agent which has caused this emotion
new_emotion("joy",agent1)
- Various combinations are possible to create the emotion: (name,intensity,about), (name,about,cause), (name,intensity,cause)...
new_emotion("joy",12.3,eatFood)
new_emotion("joy",eatFood,agent1)
new_emotion("joy",12.3,agent1)
Examples:​
new_emotion("joy")
emotion("joy",12.3,eatFood,4,agent1)
new_emotion("joy",12.3,eatFood,agent1)
emotion("joy", 12.3, 4, agent1)
new_emotion("joy",12.3,eatFood,4.0)
new_folder
​
Possible uses:​
new_folder
(string
) --->file
Result:​
opens an existing repository or create a new folder if it does not exist.
Special cases:​
- If the specified string does not refer to an existing repository, the repository is created.
- If the string refers to an existing file, an exception is risen.
Examples:​
file dirNewT <- new_folder("incl/"); // dirNewT represents the repository "../incl/"
// eventually creates the directory ../incl
See also: folder, file, folder_exists,
new_mental_state
​
Possible uses:​
new_mental_state
(string
) --->mental_state
string
new_mental_state
mental_state
--->mental_state
new_mental_state
(string
,mental_state
) --->mental_state
string
new_mental_state
predicate
--->mental_state
new_mental_state
(string
,predicate
) --->mental_state
string
new_mental_state
emotion
--->mental_state
new_mental_state
(string
,emotion
) --->mental_state
new_mental_state
(string
,mental_state
,int
) --->mental_state
new_mental_state
(string
,emotion
,int
) --->mental_state
new_mental_state
(string
,mental_state
,float
) --->mental_state
new_mental_state
(string
,emotion
,float
) --->mental_state
new_mental_state
(string
,predicate
,agent
) --->mental_state
new_mental_state
(string
,emotion
,agent
) --->mental_state
new_mental_state
(string
,predicate
,int
) --->mental_state
new_mental_state
(string
,mental_state
,agent
) --->mental_state
new_mental_state
(string
,predicate
,float
) --->mental_state
new_mental_state
(string
,emotion
,float
,agent
) --->mental_state
new_mental_state
(string
,mental_state
,float
,agent
) --->mental_state
new_mental_state
(string
,mental_state
,float
,int
) --->mental_state
new_mental_state
(string
,emotion
,int
,agent
) --->mental_state
new_mental_state
(string
,emotion
,float
,int
) --->mental_state
new_mental_state
(string
,predicate
,int
,agent
) --->mental_state
new_mental_state
(string
,predicate
,float
,int
) --->mental_state
new_mental_state
(string
,mental_state
,int
,agent
) --->mental_state
new_mental_state
(string
,predicate
,float
,agent
) --->mental_state
new_mental_state
(string
,mental_state
,float
,int
,agent
) --->mental_state
new_mental_state
(string
,predicate
,float
,int
,agent
) --->mental_state
new_mental_state
(string
,emotion
,float
,int
,agent
) --->mental_state
Result:​
creates a new mental state with a given modality (e.g. belief or desire) and various properties (a predicate it is about, a strength, a lifetime, an ower agent and an emotion it is about
Examples:​
new_mental_state("belief", mental_state1, 12.3, 10, agent1)
new_mental_state("belief", mental_state1, 10)
new_mental_state("belief", my_joy, 10)
new_mental_state("belief")
new_mental_state("belief",raining, 12.3, 10, agent1)
new_mental_state("belief", mental_state1, 12.3)
new_mental_state("belief", my_joy, 12.3, agent1)
new_mental_state("belief", my_joy, 12.3, 10, agent1)
new_mental_state("belief", mental_state1, 12.2, agent1)
new_mental_state("belief", mental_state1, 12.3, 10)
new_mental_state("belief", my_joy, 12.3)
new_mental_state("belief", my_joy, 10, agent1)
new_mental_state("belief", my_joy, 12.3, 10)
new_mental_state("belief", raining, 10, agent1)
new_mental_state("belief", mental_state1)
new_mental_state("belief", raining)
new_mental_state("belief", raining, agent1)
new_mental_state("belief", my_joy, agent1)
new_mental_state("belief", raining, 12.4, 10)
new_mental_state("belief", mental_state1, 10, agent1)
new_mental_state("belief", raining, 10)
new_mental_state("belief", raining, 12.3, agent1)
new_mental_state("belief", mental_state1, agent1)
new_mental_state("belief", my_joy)
new_mental_state("belief", raining, 0.5)
new_predicate
​
Possible uses:​
new_predicate
(string
) --->predicate
string
new_predicate
bool
--->predicate
new_predicate
(string
,bool
) --->predicate
string
new_predicate
map
--->predicate
new_predicate
(string
,map
) --->predicate
string
new_predicate
agent
--->predicate
new_predicate
(string
,agent
) --->predicate
new_predicate
(string
,map
,bool
) --->predicate
new_predicate
(string
,map
,agent
) --->predicate
new_predicate
(string
,map
,bool
,agent
) --->predicate
Result:​
creates a new predicate with a given name and adidtional properties (values, agent causing the predicate, whether it is true...)
Examples:​
new_predicate("hasWater", true)
new_predicate("people to meet", ["time"::10], true)
new_predicate("people to meet", map(["val1"::23]) )
new_predicate("people to meet", ["time"::10], agentA)
new_predicate("people to meet", agent1)
new_predicate("people to meet")
new_predicate("people to meet", ["time"::10], true, agentA)
new_social_link
​
Possible uses:​
new_social_link
(agent
) --->social_link
new_social_link
(agent
,float
,float
,float
,float
) --->social_link
Result:​
creates a new social link with another agent (eventually given additional parameters such as the appreciation, dominance, solidarity, and familiarity values).
Examples:​
new_social_link(agentA)
new_social_link(agentA,0.0,-0.1,0.2,0.1)
node
​
Possible uses:​
node
(unknown
) --->unknown
unknown
node
float
--->unknown
node
(unknown
,float
) --->unknown
Result:​
Allows to create a wrapper (of type unknown) that wraps an actual object and indicates it should be considered as a node of a graph. The second (optional) parameter indicates which weight the node should have in the graph
Comment:​
Useful only in graph-related operations (addition, removal of nodes, creation of graphs)
nodes
​
Possible uses:​
nodes
(container
) --->container
Result:​
Allows to create a wrapper (of type list) that wraps a list of objects and indicates they should be considered as nodes of a graph
none_matches
​
Possible uses:​
container
none_matches
any expression
--->bool
none_matches
(container
,any expression
) --->bool
Result:​
Returns true if none of the elements of the left-hand operand make the right-hand operand evaluate to true. 'c none_matches each.property' is strictly equivalent to '(c count each.property) = 0'
Comment:​
In the right-hand operand, the keyword each can be used to represent, in turn, each of the elements.
Special cases:​
- If the left-hand operand is nil, none_matches throws an error.
- If the left-hand operand is empty, none_matches returns true.
Examples:​
bool var0 <- [1,2,3,4,5,6,7,8] none_matches (each > 3); // var0 equals false
bool var1 <- [1::2, 3::4, 5::6] none_matches (each > 4); // var1 equals false
See also: one_matches, all_match, count,
none_verifies
​
Same signification as none_matches
norm
​
Possible uses:​
norm
(point
) --->float
Result:​
the norm of the vector with the coordinates of the point operand.
Examples:​
float var0 <- norm({3,4}); // var0 equals 5.0
Norm
​
Possible uses:​
Norm
(any
) --->Norm
Result:​
casts the operand in a Norm object.
normal_area
​
Possible uses:​
normal_area
(float
,float
,float
) --->float
Result:​
Returns the area to the left of x in the normal distribution with the given mean and standard deviation.
Examples:​
float var0 <- normal_area(0.9,0,1) with_precision(3); // var0 equals 0.816
normal_density
​
Possible uses:​
normal_density
(float
,float
,float
) --->float
Result:​
Returns the probability of x in the normal distribution with the given mean and standard deviation.
Examples:​
float var0 <- (normal_density(2,1,1)*100) with_precision 2; // var0 equals 24.2
normal_inverse
​
Possible uses:​
normal_inverse
(float
,float
,float
) --->float
Result:​
Returns the x in the normal distribution with the given mean and standard deviation, to the left of which lies the given area. normal.
Examples:​
float var0 <- normal_inverse(0.98,0,1) with_precision(2); // var0 equals 2.05
normalized_rotation
​
Possible uses:​
normalized_rotation
(pair
) --->pair<float,point>
Result:​
The rotation normalized according to Euler formalism with a positive angle, such that each rotation has a unique set of parameters (positive angle, normalize axis rotation).
Examples:​
pair<float,point> var0 <- normalized_rotation(-38.0::{1,1,1}); // var0 equals 38.0::{-0.5773502691896258,-0.5773502691896258,-0.5773502691896258}
See also: [rotation_composition, inverse_rotation](OperatorsSZ#rotation_composition, inverse_rotation),
not
​
Same signification as !
not
​
Possible uses:​
not
(predicate
) --->predicate
Result:​
create a new predicate with the inverse truth value
Examples:​
not predicate1
obj_file
​
Possible uses:​
obj_file
(string
) --->file
string
obj_file
pair<float,point>
--->file
obj_file
(string
,pair<float,point>
) --->file
string
obj_file
string
--->file
obj_file
(string
,string
) --->file
obj_file
(string
,string
,pair<float,point>
) --->file
Result:​
Constructs a file of type obj. Allowed extensions are limited to obj, OBJ