Documentation for module hfx_compression_methods

routines and types for Hartree-Fock-Exchange

source: hfx_compression_methods.F
Loading...

public Subroutines/Functions:

- This routine adds an a few real values to a cache. If the cache is full a compression routine is invoked and the cache is cleared
- This routine adds an int_8 value to a cache. If the cache is full a compression routine is invoked and the cache is cleared
- This routine decompresses the first bunch of data in a container and copies them into a cache
- This routine compresses the last probably not yet compressed cache into a container
- This routine returns a bunch real values from a cache. If the cache is empty a decompression routine is invoked and the cache is refilled with decompressed values from a container
- This routine returns an int_8 value from a cache. If the cache is empty a decompression routine is invoked and the cache is refilled with decompressed values from a container
- This routine resets the containers list pointer to the first element and moves the element counters of container and cache to the beginning

SUBROUTINEhfx_add_mult_cache_elements(values, nints, nbits, cache, container, eps_schwarz, pmax_entry, memory_usage, use_disk_storage)

- This routine adds an a few real values to a cache. If the cache is full a compression routine is invoked and the cache is cleared

Arguments:
REAL(dp)
:: values(*) values to be added to the cache
INTEGER,
INTENT(in)
:: nints ...
INTEGER,
INTENT(in)
:: nbits number of bits to be stored
:: cache cache to which we want to add
:: container container that contains the compressed elements
REAL(dp),
INTENT(in)
:: eps_schwarz ...
REAL(dp),
INTENT(in)
:: pmax_entry ...
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...

SUBROUTINEhfx_add_single_cache_element(value, nbits, cache, container, memory_usage, use_disk_storage, max_val_memory)

- This routine adds an int_8 value to a cache. If the cache is full a compression routine is invoked and the cache is cleared

Arguments:
INTEGER(int_8)
:: value value to be added to the cache
INTEGER
:: nbits number of bits to be stored
:: cache cache to which we want to add
:: container container that contains the compressed elements
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...
INTEGER(int_8),
OPTIONAL
:: max_val_memory ...

SUBROUTINEhfx_decompress_first_cache(nbits, cache, container, memory_usage, use_disk_storage)

- This routine decompresses the first bunch of data in a container and copies them into a cache

Arguments:
INTEGER
:: nbits number of bits with which the data has been stored
:: cache array where we want to decompress the data
:: container container that contains the compressed elements
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...

SUBROUTINEhfx_flush_last_cache(nbits, cache, container, memory_usage, use_disk_storage)

- This routine compresses the last probably not yet compressed cache into a container

Arguments:
INTEGER
:: nbits number of bits with which the data has been stored
:: cache array where we want to decompress the data
:: container container that contains the compressed elements
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...

SUBROUTINEhfx_get_mult_cache_elements(values, nints, nbits, cache, container, eps_schwarz, pmax_entry, memory_usage, use_disk_storage)

- This routine returns a bunch real values from a cache. If the cache is empty a decompression routine is invoked and the cache is refilled with decompressed values from a container

Arguments:
REAL(dp)
:: values(*) value to be retained from the cache
INTEGER,
INTENT(in)
:: nints number of values to be retained
INTEGER,
INTENT(in)
:: nbits number of bits with which the value has been compressed
:: cache cache from which we get the value
:: container container that contains the compressed elements
REAL(dp),
INTENT(in)
:: eps_schwarz threshold for storage
REAL(dp),
INTENT(in)
:: pmax_entry multiplication factor for values
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...

SUBROUTINEhfx_get_single_cache_element(value, nbits, cache, container, memory_usage, use_disk_storage)

- This routine returns an int_8 value from a cache. If the cache is empty a decompression routine is invoked and the cache is refilled with decompressed values from a container

Arguments:
INTEGER(int_8)
:: value value to be retained from the cache
INTEGER
:: nbits number of bits with which the value has been compressed
:: cache cache from which we get the value
:: container container that contains the compressed elements
INTEGER
:: memory_usage ...
LOGICAL
:: use_disk_storage ...

SUBROUTINEhfx_reset_cache_and_container(cache, container, memory_usage, do_disk_storage)

- This routine resets the containers list pointer to the first element and moves the element counters of container and cache to the beginning

Arguments:
:: cache cache from which we get the value
:: container container that contains the compressed elements
INTEGER
:: memory_usage ...
LOGICAL
:: do_disk_storage ...