Did you know ... Search Documentation:
Pack logtalk -- logtalk-3.86.0/docs/_sources/counters_0.rst.txt

.. index:: counters .. _counters/0:

.. rst-class:: right

category

counters

Named integer counters. Counter names can be any nonvar term.

| Availability: | logtalk_load(library(loader))

| Author: Paulo Moura | Version: 1:0:1 | Date: 2022-02-11

| Compilation flags: | static

| Dependencies: | (none)

| Remarks: | (none)

| Inherited public predicates: | (none)

.. contents:: :local: :backlinks: top

Public predicates

.. index:: counter/2 .. _counters/0::counter/2:

counter/2 ^^^^^^^^^^^^^

True if Counter is a counter with value Value.

| Compilation flags: | static

| Template: | counter(Counter,Value) | Mode and number of proofs: | counter(?nonvar,?integer) - zero_or_more


.. index:: increment_counter/1 .. _counters/0::increment_counter/1:

increment_counter/1 ^^^^^^^^^^^^^^^^^^^^^^^

Increments the named counter.

| Compilation flags: | static

| Template: | increment_counter(Counter) | Mode and number of proofs: | increment_counter(+nonvar) - one


.. index:: decrement_counter/1 .. _counters/0::decrement_counter/1:

decrement_counter/1 ^^^^^^^^^^^^^^^^^^^^^^^

Decrements the named counter.

| Compilation flags: | static

| Template: | decrement_counter(Counter) | Mode and number of proofs: | decrement_counter(+nonvar) - one


.. index:: reset_counter/1 .. _counters/0::reset_counter/1:

reset_counter/1 ^^^^^^^^^^^^^^^^^^^

Resets the named counter to zero. Creates the counter if it does not exist.

| Compilation flags: | static

| Template: | reset_counter(Counter) | Mode and number of proofs: | reset_counter(+nonvar) - one


.. index:: reset_counters/0 .. _counters/0::reset_counters/0:

reset_counters/0 ^^^^^^^^^^^^^^^^^^^^

Resets all existing named counters to zero.

| Compilation flags: | static

| Mode and number of proofs: | reset_counters - one


Protected predicates

(none)

Private predicates

.. index:: counter_/2 .. _counters/0::counter_/2:

counter_/2 ^^^^^^^^^^^^^^

Table of named counters.

| Compilation flags: | dynamic

| Template: | counter_(Counter,Value) | Mode and number of proofs: | counter_(?nonvar,?integer) - zero_or_more


Operators

(none)