Skip to content

mod_set_character

Lines: 167 | Visibility: public

Ordered set with unique entries author: Moritz R. Schaefer

Dependencies

Uses

module~~mod_set_character~~UsesGraph module~mod_set_character mod_set_character module~mod_throw mod_throw module~mod_set_character->module~mod_throw iso_c_binding iso_c_binding module~mod_throw->iso_c_binding iso_fortran_env iso_fortran_env module~mod_throw->iso_fortran_env module~mod_io mod_io module~mod_throw->module~mod_io module~mod_mpi mod_mpi module~mod_throw->module~mod_mpi module~mod_precision mod_precision module~mod_throw->module~mod_precision module~mod_sort mod_sort module~mod_throw->module~mod_sort module~mod_io->iso_fortran_env module~mod_io->module~mod_precision module~mod_optional_args mod_optional_args module~mod_io->module~mod_optional_args module~mod_mpi->module~mod_precision mpi_f08 mpi_f08 module~mod_mpi->mpi_f08 module~mod_precision->iso_c_binding module~mod_precision->iso_fortran_env module~mod_sort->module~mod_precision

Used By

module~~mod_set_character~~UsedByGraph module~mod_set_character mod_set_character module~mod_element mod_element module~mod_element->module~mod_set_character module~mod_atomic_descriptor mod_atomic_descriptor module~mod_atomic_descriptor->module~mod_element module~mod_feature_calculator mod_feature_calculator module~mod_feature_calculator->module~mod_element module~mod_feature_calculator->module~mod_atomic_descriptor module~mod_featuredata mod_featuredata module~mod_featuredata->module~mod_element module~mod_featuredata->module~mod_feature_calculator module~mod_initialize mod_initialize module~mod_initialize->module~mod_element module~mod_initialize->module~mod_feature_calculator module~mod_two_body mod_two_body module~mod_initialize->module~mod_two_body module~mod_scalingdata mod_scalingdata module~mod_scalingdata->module~mod_element module~mod_scalingdata->module~mod_feature_calculator module~mod_calc_atomic_properties mod_calc_atomic_properties module~mod_calc_atomic_properties->module~mod_feature_calculator module~mod_chain_features mod_chain_features module~mod_chain_features->module~mod_feature_calculator module~mod_dataloader_file mod_dataloader_file module~mod_dataloader_file->module~mod_feature_calculator module~mod_memory_estimation mod_memory_estimation module~mod_dataloader_file->module~mod_memory_estimation module~mod_dataset_statistics mod_dataset_statistics module~mod_dataset_statistics->module~mod_feature_calculator module~mod_dataset_statistics->module~mod_dataloader_file module~mod_dataset_statistics_chi_all_chunks mod_dataset_statistics_chi_all_chunks module~mod_dataset_statistics_chi_all_chunks->module~mod_feature_calculator module~mod_dataset_statistics_chi_all_chunks->module~mod_dataloader_file module~mod_dataset_statistics_chi_all_chunks->module~mod_dataset_statistics module~mod_enforce_reading mod_enforce_reading module~mod_enforce_reading->module~mod_feature_calculator module~mod_evaluate_4g_single_structure mod_evaluate_4g_single_structure module~mod_evaluate_4g_single_structure->module~mod_feature_calculator module~mod_evaluate_4g_single_structure->module~mod_chain_features module~mod_evaluate_electrostatics_3g_single_structure mod_evaluate_electrostatics_3g_single_structure module~mod_evaluate_electrostatics_3g_single_structure->module~mod_feature_calculator module~mod_evaluate_electrostatics_3g_single_structure->module~mod_chain_features module~mod_feature_calculator_statistics mod_feature_calculator_statistics module~mod_feature_calculator_statistics->module~mod_feature_calculator module~mod_feature_calculator_statistics->module~mod_scalingdata module~mod_feature_map_scaling_all_chunks mod_feature_map_scaling_all_chunks module~mod_feature_map_scaling_all_chunks->module~mod_feature_calculator module~mod_feature_map_scaling_all_chunks->module~mod_dataloader_file module~mod_feature_map_scaling_all_chunks->module~mod_feature_calculator_statistics module~mod_precalc_nl_deriv_features_single_chunk mod_precalc_nl_deriv_features_single_chunk module~mod_feature_map_scaling_all_chunks->module~mod_precalc_nl_deriv_features_single_chunk module~mod_prediction_statistics mod_prediction_statistics module~mod_feature_map_scaling_all_chunks->module~mod_prediction_statistics module~mod_structure_batch_iterator mod_structure_batch_iterator module~mod_feature_map_scaling_all_chunks->module~mod_structure_batch_iterator module~mod_global_features_helper mod_global_features_helper module~mod_global_features_helper->module~mod_feature_calculator module~mod_memory_estimation->module~mod_feature_calculator module~mod_output_files_and_cost mod_output_files_and_cost module~mod_output_files_and_cost->module~mod_feature_calculator module~mod_output_files_and_cost->module~mod_dataloader_file module~mod_predict_multiple_structures mod_predict_multiple_structures module~mod_output_files_and_cost->module~mod_predict_multiple_structures module~mod_cost_calculator mod_cost_calculator module~mod_output_files_and_cost->module~mod_cost_calculator module~mod_output_files_and_cost_4g_charges mod_output_files_and_cost_4g_charges module~mod_output_files_and_cost_4g_charges->module~mod_feature_calculator module~mod_output_files_and_cost_4g_charges->module~mod_dataloader_file module~mod_predict_4g_charges_training_qeq_multiple_structures mod_predict_4g_charges_training_qeq_multiple_structures module~mod_output_files_and_cost_4g_charges->module~mod_predict_4g_charges_training_qeq_multiple_structures module~mod_output_files_and_cost_4g_charges->module~mod_cost_calculator module~mod_output_files_and_cost_4g_short_range mod_output_files_and_cost_4g_short_range module~mod_output_files_and_cost_4g_short_range->module~mod_feature_calculator module~mod_output_files_and_cost_4g_short_range->module~mod_dataloader_file module~mod_predict_4g_short_range_training_qeq_multiple_structures mod_predict_4g_short_range_training_qeq_multiple_structures module~mod_output_files_and_cost_4g_short_range->module~mod_predict_4g_short_range_training_qeq_multiple_structures module~mod_predict_qeq_feature_calculator_multiple_structures mod_predict_qeq_feature_calculator_multiple_structures module~mod_output_files_and_cost_4g_short_range->module~mod_predict_qeq_feature_calculator_multiple_structures module~mod_output_files_and_cost_4g_short_range->module~mod_cost_calculator module~mod_post_processing_2g_single_structure mod_post_processing_2g_single_structure module~mod_post_processing_2g_single_structure->module~mod_feature_calculator module~mod_post_processing_2g_single_structure->module~mod_chain_features module~mod_post_processing_3g_single_structure mod_post_processing_3g_single_structure module~mod_post_processing_3g_single_structure->module~mod_feature_calculator module~mod_post_processing_3g_single_structure->module~mod_evaluate_electrostatics_3g_single_structure module~mod_post_processing_4g_single_structure mod_post_processing_4g_single_structure module~mod_post_processing_4g_single_structure->module~mod_feature_calculator module~mod_post_processing_4g_single_structure->module~mod_evaluate_4g_single_structure module~mod_post_processing_vdw_hirshfeld_single_structure mod_post_processing_vdw_hirshfeld_single_structure module~mod_post_processing_vdw_hirshfeld_single_structure->module~mod_feature_calculator module~mod_post_processing_vdw_hirshfeld_single_structure->module~mod_chain_features module~mod_post_processing_wrapper_single_structure mod_post_processing_wrapper_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_feature_calculator module~mod_post_processing_wrapper_single_structure->module~mod_calc_atomic_properties module~mod_post_processing_wrapper_single_structure->module~mod_evaluate_4g_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_global_features_helper module~mod_post_processing_wrapper_single_structure->module~mod_post_processing_2g_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_post_processing_3g_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_post_processing_4g_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_post_processing_vdw_hirshfeld_single_structure module~mod_post_processing_wrapper_single_structure->module~mod_two_body module~mod_precalc_coulomb_matrix_all_chunks mod_precalc_coulomb_matrix_all_chunks module~mod_precalc_coulomb_matrix_all_chunks->module~mod_feature_calculator module~mod_precalc_coulomb_matrix_all_chunks->module~mod_dataloader_file module~mod_precalc_coulomb_matrix_all_chunks->module~mod_predict_4g_charges_training_qeq_multiple_structures module~mod_precalc_nl_deriv_features_single_chunk->module~mod_feature_calculator module~mod_precalc_nl_deriv_features_single_chunk->module~mod_dataloader_file module~mod_precalc_nl_deriv_features_single_chunk->module~mod_memory_estimation module~mod_precompute_features_all_chunks mod_precompute_features_all_chunks module~mod_precompute_features_all_chunks->module~mod_feature_calculator module~mod_precompute_features_all_chunks->module~mod_featuredata module~mod_precompute_features_all_chunks->module~mod_dataloader_file module~mod_precompute_features_all_chunks->module~mod_feature_calculator_statistics module~mod_precompute_global_features_all_chunks mod_precompute_global_features_all_chunks module~mod_precompute_global_features_all_chunks->module~mod_feature_calculator module~mod_precompute_global_features_all_chunks->module~mod_dataloader_file module~mod_precompute_global_features_all_chunks->module~mod_feature_calculator_statistics module~mod_predict_ee4g_feature_calculator_multiple_structures mod_predict_ee4g_feature_calculator_multiple_structures module~mod_precompute_global_features_all_chunks->module~mod_predict_ee4g_feature_calculator_multiple_structures module~mod_precompute_global_features_all_chunks->module~mod_predict_qeq_feature_calculator_multiple_structures module~mod_predict_4g_charges_training_qeq_multiple_structures->module~mod_feature_calculator module~mod_predict_4g_charges_training_qeq_multiple_structures->module~mod_structure_batch_iterator module~mod_predict_4g_no_force_trick_single_structure mod_predict_4g_no_force_trick_single_structure module~mod_predict_4g_no_force_trick_single_structure->module~mod_feature_calculator module~mod_predict_4g_no_force_trick_single_structure->module~mod_calc_atomic_properties module~mod_predict_4g_no_force_trick_single_structure->module~mod_global_features_helper module~mod_predict_4g_short_range_training_qeq_single_structure mod_predict_4g_short_range_training_qeq_single_structure module~mod_predict_4g_no_force_trick_single_structure->module~mod_predict_4g_short_range_training_qeq_single_structure module~mod_predict_qeq_feature_calculator_single_structure mod_predict_qeq_feature_calculator_single_structure module~mod_predict_4g_no_force_trick_single_structure->module~mod_predict_qeq_feature_calculator_single_structure module~mod_predict_4g_short_range_training_qeq_multiple_structures->module~mod_feature_calculator module~mod_predict_4g_short_range_training_qeq_multiple_structures->module~mod_global_features_helper module~mod_predict_4g_short_range_training_qeq_multiple_structures->module~mod_predict_4g_short_range_training_qeq_single_structure module~mod_predict_4g_short_range_training_qeq_multiple_structures->module~mod_structure_batch_iterator module~mod_predict_4g_short_range_training_qeq_single_structure->module~mod_feature_calculator module~mod_predict_4g_short_range_training_qeq_single_structure->module~mod_post_processing_2g_single_structure module~mod_predict_all_chunks mod_predict_all_chunks module~mod_predict_all_chunks->module~mod_feature_calculator module~mod_predict_all_chunks->module~mod_dataloader_file module~mod_predict_all_chunks->module~mod_predict_multiple_structures module~mod_predict_all_chunks->module~mod_two_body module~mod_predict_ee4g_feature_calculator_multiple_structures->module~mod_feature_calculator module~mod_predict_ee4g_feature_calculator_multiple_structures->module~mod_dataloader_file module~mod_predict_mode mod_predict_mode module~mod_predict_mode->module~mod_feature_calculator module~mod_predict_mode->module~mod_initialize module~mod_predict_mode->module~mod_dataloader_file module~mod_predict_mode->module~mod_enforce_reading module~mod_predict_mode->module~mod_feature_calculator_statistics module~mod_predict_mode->module~mod_predict_multiple_structures module~mod_write_outfiles mod_write_outfiles module~mod_predict_mode->module~mod_write_outfiles module~mod_predict_mode->module~mod_two_body module~mod_predict_multiple_structures->module~mod_feature_calculator module~mod_predict_multiple_structures->module~mod_post_processing_wrapper_single_structure module~mod_predict_multiple_structures->module~mod_structure_batch_iterator module~mod_predict_multiple_structures->module~mod_two_body module~mod_predict_qeq_feature_calculator_multiple_structures->module~mod_feature_calculator module~mod_predict_qeq_feature_calculator_multiple_structures->module~mod_dataloader_file module~mod_predict_qeq_feature_calculator_multiple_structures->module~mod_predict_qeq_feature_calculator_single_structure module~mod_predict_qeq_feature_calculator_multiple_structures->module~mod_structure_batch_iterator module~mod_predict_qeq_feature_calculator_single_structure->module~mod_feature_calculator module~mod_predict_qeq_feature_calculator_single_structure->module~mod_chain_features module~mod_predict_single_structure mod_predict_single_structure module~mod_predict_single_structure->module~mod_feature_calculator module~mod_predict_single_structure->module~mod_calc_atomic_properties module~mod_predict_single_structure->module~mod_post_processing_wrapper_single_structure module~mod_predict_single_structure->module~mod_two_body module~mod_prediction_statistics->module~mod_feature_calculator module~mod_prediction_statistics->module~mod_calc_atomic_properties module~mod_runner_interface mod_runner_interface module~mod_runner_interface->module~mod_feature_calculator module~mod_runner_interface->module~mod_two_body module~mod_runner_interface_bindings mod_runner_interface_bindings module~mod_runner_interface_bindings->module~mod_feature_calculator module~mod_runner_interface_bindings->module~mod_initialize module~mod_runner_interface_bindings->module~mod_calc_atomic_properties module~mod_runner_interface_bindings->module~mod_enforce_reading module~mod_runner_interface_bindings->module~mod_evaluate_4g_single_structure module~mod_runner_interface_bindings->module~mod_evaluate_electrostatics_3g_single_structure module~mod_runner_interface_bindings->module~mod_feature_calculator_statistics module~mod_runner_interface_bindings->module~mod_global_features_helper module~mod_runner_interface_bindings->module~mod_post_processing_2g_single_structure module~mod_runner_interface_bindings->module~mod_post_processing_vdw_hirshfeld_single_structure module~mod_runner_interface_bindings->module~mod_runner_interface module~mod_runner_interface_bindings->module~mod_two_body module~mod_structure_batch_iterator->module~mod_feature_calculator module~mod_structure_batch_iterator->module~mod_calc_atomic_properties module~mod_structure_batch_iterator->module~mod_global_features_helper module~mod_train_4g_atomic_charges_structure_batch mod_train_4g_atomic_charges_structure_batch module~mod_train_4g_atomic_charges_structure_batch->module~mod_feature_calculator module~mod_train_4g_atomic_charges_structure_batch->module~mod_dataloader_file module~mod_train_atomic_property_multiple_atoms mod_train_atomic_property_multiple_atoms module~mod_train_atomic_property_multiple_atoms->module~mod_feature_calculator module~mod_train_energy_multiple_structures mod_train_energy_multiple_structures module~mod_train_energy_multiple_structures->module~mod_initialize module~mod_train_forces_multiple_structures mod_train_forces_multiple_structures module~mod_train_forces_multiple_structures->module~mod_initialize module~mod_train_forces_multiple_structures->module~mod_train_energy_multiple_structures module~mod_train_loop_4g_charges mod_train_loop_4g_charges module~mod_train_loop_4g_charges->module~mod_feature_calculator module~mod_train_loop_4g_charges->module~mod_initialize module~mod_train_loop_4g_charges->module~mod_dataloader_file module~mod_train_loop_4g_charges->module~mod_output_files_and_cost_4g_charges module~mod_train_loop_4g_charges->module~mod_train_4g_atomic_charges_structure_batch module~mod_train_loop_4g_charges->module~mod_cost_calculator module~mod_train_loop_atomic_property mod_train_loop_atomic_property module~mod_train_loop_atomic_property->module~mod_feature_calculator module~mod_train_loop_atomic_property->module~mod_initialize module~mod_train_loop_atomic_property->module~mod_dataloader_file module~mod_train_loop_atomic_property->module~mod_output_files_and_cost module~mod_train_loop_atomic_property->module~mod_train_atomic_property_multiple_atoms module~mod_train_loop_atomic_property->module~mod_cost_calculator module~mod_train_loop_short_range mod_train_loop_short_range module~mod_train_loop_short_range->module~mod_feature_calculator module~mod_train_loop_short_range->module~mod_initialize module~mod_train_loop_short_range->module~mod_dataloader_file module~mod_train_loop_short_range->module~mod_global_features_helper module~mod_train_loop_short_range->module~mod_output_files_and_cost module~mod_train_loop_short_range->module~mod_output_files_and_cost_4g_short_range module~mod_train_loop_short_range->module~mod_predict_ee4g_feature_calculator_multiple_structures module~mod_train_loop_short_range->module~mod_predict_qeq_feature_calculator_multiple_structures module~mod_train_loop_short_range->module~mod_train_energy_multiple_structures module~mod_train_loop_short_range->module~mod_train_forces_multiple_structures module~mod_train_loop_short_range->module~mod_cost_calculator module~mod_train_mode mod_train_mode module~mod_train_mode->module~mod_feature_calculator module~mod_train_mode->module~mod_initialize module~mod_train_mode->module~mod_dataloader_file module~mod_train_mode->module~mod_dataset_statistics module~mod_train_mode->module~mod_dataset_statistics_chi_all_chunks module~mod_train_mode->module~mod_feature_calculator_statistics module~mod_train_mode->module~mod_feature_map_scaling_all_chunks module~mod_train_mode->module~mod_precalc_coulomb_matrix_all_chunks module~mod_train_mode->module~mod_precalc_nl_deriv_features_single_chunk module~mod_train_mode->module~mod_predict_4g_charges_training_qeq_multiple_structures module~mod_train_mode->module~mod_predict_all_chunks module~mod_train_mode->module~mod_predict_ee4g_feature_calculator_multiple_structures module~mod_train_mode->module~mod_predict_qeq_feature_calculator_multiple_structures module~mod_train_mode->module~mod_train_loop_4g_charges module~mod_train_mode->module~mod_train_loop_atomic_property module~mod_train_mode->module~mod_train_loop_short_range module~mod_train_mode->module~mod_two_body module~mod_write_outfiles_training mod_write_outfiles_training module~mod_train_mode->module~mod_write_outfiles_training module~mod_write_outfiles->module~mod_initialize program~runner RuNNer program~runner->module~mod_feature_calculator program~runner->module~mod_initialize program~runner->module~mod_dataloader_file program~runner->module~mod_precompute_features_all_chunks program~runner->module~mod_precompute_global_features_all_chunks program~runner->module~mod_predict_mode program~runner->module~mod_train_mode module~mod_calculate_coulomb_matrix mod_calculate_coulomb_matrix program~runner->module~mod_calculate_coulomb_matrix program~runner->module~mod_two_body module~mod_calculate_coulomb_matrix->module~mod_dataloader_file module~mod_cost_calculator->module~mod_dataloader_file module~mod_cost_calculator->module~mod_write_outfiles_training module~mod_feature_calc_interface mod_feature_calc_interface module~mod_feature_calc_interface->module~mod_runner_interface module~mod_generic_interface mod_generic_interface module~mod_feature_calc_interface->module~mod_generic_interface module~mod_generic_interface->module~mod_predict_single_structure module~mod_generic_interface->module~mod_runner_interface module~mod_lammps_interface mod_lammps_interface module~mod_lammps_interface->module~mod_runner_interface module~mod_lammps_interface->module~mod_runner_interface_bindings module~mod_two_body->module~mod_dataloader_file module~mod_write_outfiles_training->module~mod_write_outfiles

Derived Types Summary

Name Description
SetCharacter Set of characters This type represents a set of characters. The elements are stored in an...

Procedures Summary

Name Type Description
constructor_empty Function Create an empty SetCharacter that stores strings of a given len.
constructor_from_elements Function Create a set from a list of elements The elements will be added to the set in the order they are given
constructor_from_element Function Create a set from a one element
contains Function Check if an element is in the set Returns .true. if the element is in the set, .false. otherwise
get_elements Function Get all elements of the set
get_size Function Get the number of elements in the set
intersect Function Get the intersection of two sets The intersection of two sets is the set of elements that are...
union Function Get the union of two sets The union of two sets is the set of elements that are in either set
difference Function Get the difference of two sets The difference of two sets is the set of elements that are in...
symmetric_difference Function Get the symmetric difference of two sets The symmetric difference of two sets is the set of...
is_subset Function Check if a another set is a subset of this set
is_superset Function Check if a another set is a superset of this set
get_index_in_set Function Get the index of an element in the set Returns -1 if the element is not in the set
get_element_by_index Function Get the element at a specific index Throws an error if the index is out of range
add_element Subroutine Create a set from a list of sets Add an element to the set If the element is already in the...
add_elements Subroutine Add multiple elements to the set If an element is already in the set, it will not be added again
remove Subroutine Remove an element from the set If the element is not in the set, nothing will be done

Derived Types Details

type SetCharacter

Set of characters

This type represents a set of characters. The elements are stored in an array and are unique. The order of the elements is preserved.

Components

  • elements : character– Elements of the set
  • size : integer– Number of elements in the set
  • len : integer– Length of the character arrays in the set

Type-Bound Procedures

Name Attributes Binding
remove public ⇒ remove
contains public ⇒ contains
get_size public ⇒ get_size
get_elements public ⇒ get_elements
intersect public ⇒ intersect
union public ⇒ union
difference public ⇒ difference
symmetric_difference public ⇒ symmetric_difference
is_subset public ⇒ is_subset
is_superset public ⇒ is_superset
get_index_in_set public ⇒ get_index_in_set
get_element_by_index public ⇒ get_element_by_index
add public ⇒ add_element⇒ add_elements
add_element private ⇒ add_element
add_elements private ⇒ add_elements

Interface Details

interface SetCharacter


Procedure Details

function constructor_empty

function constructor_empty( &
    len &
)

Create an empty SetCharacter that stores strings of a given len.

Arguments

  • len : integer [in]

Called By

proc~~constructor_empty~~CalledByGraph proc~constructor_empty mod_set_character::constructor_empty interface~setcharacter mod_set_character::SetCharacter interface~setcharacter->proc~constructor_empty

function constructor_from_elements

function constructor_from_elements( &
    elements &
)

Create a set from a list of elements

The elements will be added to the set in the order they are given

Arguments

  • elements : character (dim: (:)) [in]

Called By

proc~~constructor_from_elements~~CalledByGraph proc~constructor_from_elements mod_set_character::constructor_from_elements interface~setcharacter mod_set_character::SetCharacter interface~setcharacter->proc~constructor_from_elements

function constructor_from_element

function constructor_from_element( &
    element &
)

Create a set from a one element

Arguments

  • element : character [in]

Called By

proc~~constructor_from_element~~CalledByGraph proc~constructor_from_element mod_set_character::constructor_from_element interface~setcharacter mod_set_character::SetCharacter interface~setcharacter->proc~constructor_from_element

function contains

function contains( &
    self, &
    element &
)

Check if an element is in the set

Returns .true. if the element is in the set, .false. otherwise

Arguments

  • self : class(SetCharacter) [in]
  • element : character [in]– Element to check for

function get_elements

function get_elements( &
    self &
)

Get all elements of the set

Arguments

Called By

proc~~get_elements~~CalledByGraph proc~get_elements mod_set_character::SetCharacter%get_elements proc~group_feature_maps mod_element::Element%group_feature_maps proc~group_feature_maps->proc~get_elements proc~initialize_from_featuremap_list_element mod_element::Element%initialize_from_featuremap_list_element proc~initialize_from_featuremap_list_element->proc~group_feature_maps proc~constructor_from_featuremap_list_element mod_element::constructor_from_featuremap_list_element proc~constructor_from_featuremap_list_element->proc~initialize_from_featuremap_list_element proc~constructor_from_file_feature_calculator mod_feature_calculator::constructor_from_file_feature_calculator proc~constructor_from_file_feature_calculator->proc~initialize_from_featuremap_list_element interface~element mod_element::Element interface~element->proc~constructor_from_featuremap_list_element interface~featurecalculator mod_feature_calculator::FeatureCalculator interface~featurecalculator->proc~constructor_from_file_feature_calculator

function get_size

function get_size( &
    self &
)

Get the number of elements in the set

Arguments

Called By

proc~~get_size~~CalledByGraph proc~get_size mod_set_character::SetCharacter%get_size proc~group_feature_maps mod_element::Element%group_feature_maps proc~group_feature_maps->proc~get_size proc~initialize_from_featuremap_list_element mod_element::Element%initialize_from_featuremap_list_element proc~initialize_from_featuremap_list_element->proc~group_feature_maps proc~constructor_from_featuremap_list_element mod_element::constructor_from_featuremap_list_element proc~constructor_from_featuremap_list_element->proc~initialize_from_featuremap_list_element proc~constructor_from_file_feature_calculator mod_feature_calculator::constructor_from_file_feature_calculator proc~constructor_from_file_feature_calculator->proc~initialize_from_featuremap_list_element interface~element mod_element::Element interface~element->proc~constructor_from_featuremap_list_element interface~featurecalculator mod_feature_calculator::FeatureCalculator interface~featurecalculator->proc~constructor_from_file_feature_calculator

function intersect

function intersect( &
    self, &
    other &
)

Get the intersection of two sets

The intersection of two sets is the set of elements that are in both sets

Arguments


function union

function union( &
    self, &
    other &
)

Get the union of two sets

The union of two sets is the set of elements that are in either set

Arguments

Called By

proc~~union~~CalledByGraph proc~union mod_set_character::SetCharacter%union proc~symmetric_difference mod_set_character::SetCharacter%symmetric_difference proc~symmetric_difference->proc~union

function difference

function difference( &
    self, &
    other &
)

Get the difference of two sets

The difference of two sets is the set of elements that are in the first set but not in the second set

Arguments

Called By

proc~~difference~~CalledByGraph proc~difference mod_set_character::SetCharacter%difference proc~symmetric_difference mod_set_character::SetCharacter%symmetric_difference proc~symmetric_difference->proc~difference

function symmetric_difference

function symmetric_difference( &
    self, &
    other &
)

Get the symmetric difference of two sets

The symmetric difference of two sets is the set of elements that are in either set but not in both sets

Arguments


function is_subset

function is_subset( &
    self, &
    other &
)

Check if a another set is a subset of this set

Arguments

Called By

proc~~is_subset~~CalledByGraph proc~is_subset mod_set_character::SetCharacter%is_subset proc~is_superset mod_set_character::SetCharacter%is_superset proc~is_superset->proc~is_subset

function is_superset

function is_superset( &
    self, &
    other &
)

Check if a another set is a superset of this set

Arguments


function get_index_in_set

function get_index_in_set( &
    self, &
    element &
)

Get the index of an element in the set

Returns -1 if the element is not in the set

Arguments

Called By

proc~~get_index_in_set~~CalledByGraph proc~get_index_in_set mod_set_character::SetCharacter%get_index_in_set proc~group_feature_maps mod_element::Element%group_feature_maps proc~group_feature_maps->proc~get_index_in_set proc~initialize_from_featuremap_list_element mod_element::Element%initialize_from_featuremap_list_element proc~initialize_from_featuremap_list_element->proc~group_feature_maps proc~constructor_from_featuremap_list_element mod_element::constructor_from_featuremap_list_element proc~constructor_from_featuremap_list_element->proc~initialize_from_featuremap_list_element proc~constructor_from_file_feature_calculator mod_feature_calculator::constructor_from_file_feature_calculator proc~constructor_from_file_feature_calculator->proc~initialize_from_featuremap_list_element interface~element mod_element::Element interface~element->proc~constructor_from_featuremap_list_element interface~featurecalculator mod_feature_calculator::FeatureCalculator interface~featurecalculator->proc~constructor_from_file_feature_calculator

function get_element_by_index

function get_element_by_index( &
    self, &
    index &
)

Get the element at a specific index

Throws an error if the index is out of range

Arguments


subroutine add_element

subroutine add_element( &
    self, &
    element &
)

Create a set from a list of sets Add an element to the set

If the element is already in the set, it will not be added again

Arguments

  • self : class(SetCharacter) [inout]
  • element : character [in]

Called By

proc~~add_element~~CalledByGraph proc~add_element mod_set_character::SetCharacter%add_element none~add mod_set_character::SetCharacter%add none~add->proc~add_element proc~add_elements mod_set_character::SetCharacter%add_elements none~add->proc~add_elements proc~add_elements->proc~add_element proc~difference mod_set_character::SetCharacter%difference proc~difference->proc~add_element proc~constructor_from_element mod_set_character::constructor_from_element proc~constructor_from_element->none~add proc~constructor_from_elements mod_set_character::constructor_from_elements proc~constructor_from_elements->none~add proc~group_feature_maps mod_element::Element%group_feature_maps proc~group_feature_maps->none~add proc~symmetric_difference mod_set_character::SetCharacter%symmetric_difference proc~symmetric_difference->proc~difference interface~setcharacter mod_set_character::SetCharacter interface~setcharacter->proc~constructor_from_element interface~setcharacter->proc~constructor_from_elements proc~initialize_from_featuremap_list_element mod_element::Element%initialize_from_featuremap_list_element proc~initialize_from_featuremap_list_element->proc~group_feature_maps proc~constructor_from_featuremap_list_element mod_element::constructor_from_featuremap_list_element proc~constructor_from_featuremap_list_element->proc~initialize_from_featuremap_list_element proc~constructor_from_file_feature_calculator mod_feature_calculator::constructor_from_file_feature_calculator proc~constructor_from_file_feature_calculator->proc~initialize_from_featuremap_list_element interface~element mod_element::Element interface~element->proc~constructor_from_featuremap_list_element interface~featurecalculator mod_feature_calculator::FeatureCalculator interface~featurecalculator->proc~constructor_from_file_feature_calculator

subroutine add_elements

subroutine add_elements( &
    self, &
    elements &
)

Add multiple elements to the set

If an element is already in the set, it will not be added again

Arguments

  • self : class(SetCharacter) [inout]
  • elements : character [in]– Elements to add

Called By

proc~~add_elements~~CalledByGraph proc~add_elements mod_set_character::SetCharacter%add_elements none~add mod_set_character::SetCharacter%add none~add->proc~add_elements proc~constructor_from_element mod_set_character::constructor_from_element proc~constructor_from_element->none~add proc~constructor_from_elements mod_set_character::constructor_from_elements proc~constructor_from_elements->none~add proc~group_feature_maps mod_element::Element%group_feature_maps proc~group_feature_maps->none~add interface~setcharacter mod_set_character::SetCharacter interface~setcharacter->proc~constructor_from_element interface~setcharacter->proc~constructor_from_elements proc~initialize_from_featuremap_list_element mod_element::Element%initialize_from_featuremap_list_element proc~initialize_from_featuremap_list_element->proc~group_feature_maps proc~constructor_from_featuremap_list_element mod_element::constructor_from_featuremap_list_element proc~constructor_from_featuremap_list_element->proc~initialize_from_featuremap_list_element proc~constructor_from_file_feature_calculator mod_feature_calculator::constructor_from_file_feature_calculator proc~constructor_from_file_feature_calculator->proc~initialize_from_featuremap_list_element interface~element mod_element::Element interface~element->proc~constructor_from_featuremap_list_element interface~featurecalculator mod_feature_calculator::FeatureCalculator interface~featurecalculator->proc~constructor_from_file_feature_calculator

subroutine remove

subroutine remove( &
    self, &
    element &
)

Remove an element from the set

If the element is not in the set, nothing will be done

Arguments

  • self : class(SetCharacter) [inout]
  • element : character [in]– Element to remove