| Overview |  |
Copyright © The MIT License (MIT) Copyright (C) 2013 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Authors: Ricardo Tomé Gonçalves (tome.wave@gmail.com), Paulo Sérgio Almeida (pssalmeida@gmail.com).
References
An Erlang implementation of *compact* Dotted Version Vectors, which provides a container for a set of concurrent values (siblings) with causal order information.
For further reading, visit the github page.clock() = {entries(), values()}
counter() = non_neg_integer()
entries() = [{id(), counter(), values()}]
id() = any()
value() = any()
values() = [value()]
vector() = [{id(), counter()}]
| equal/2 | Compares the equality of both clocks, regarding only the causal histories, thus ignoring the values. |
| ids/1 | Returns all the ids used in this clock set. |
| join/1 | Return a version vector that represents the causal history. |
| last/2 | Returns the latest value in the clock set, according to function F(A,B), which returns *true* if A compares less than or equal to B, false otherwise. |
| less/2 | Returns True if the first clock is causally older than the second clock, thus values on the first clock are outdated. |
| lww/2 | Return a clock with the same causal history, but with only one value in its original position. |
| map/2 | Maps (applies) a function on all values in this clock set, returning the same clock set with the updated values. |
| new/1 | Constructs a new clock set without causal history, and receives a list of values that gos to the anonymous list. |
| new/2 | Constructs a new clock set with the causal history of the given version vector / vector clock, and receives a list of values that gos to the anonymous list. |
| reconcile/2 | Return a clock with the same causal history, but with only one value in the anonymous placeholder. |
| size/1 | Returns the total number of values in this clock set. |
| sync/1 | Synchronizes a list of clocks using sync/2. |
| update/2 | Advances the causal history with the given id. |
| update/3 | Advances the causal history of the first clock with the given id, while synchronizing with the second clock, thus the new clock is causally newer than both clocks in the argument. |
| values/1 | Returns all the values used in this clock set, including the anonymous values. |
Compares the equality of both clocks, regarding only the causal histories, thus ignoring the values.
Returns all the ids used in this clock set.
Return a version vector that represents the causal history.
Returns the latest value in the clock set, according to function F(A,B), which returns *true* if A compares less than or equal to B, false otherwise.
Returns True if the first clock is causally older than the second clock, thus values on the first clock are outdated. Returns False otherwise.
Return a clock with the same causal history, but with only one value in its original position. This value is the newest value in the given clock, according to function F(A,B), which returns *true* if A compares less than or equal to B, false otherwise.
Maps (applies) a function on all values in this clock set, returning the same clock set with the updated values.
Constructs a new clock set without causal history, and receives a list of values that gos to the anonymous list.
Constructs a new clock set with the causal history of the given version vector / vector clock, and receives a list of values that gos to the anonymous list. The version vector SHOULD BE a direct result of join/1.
Return a clock with the same causal history, but with only one value in the anonymous placeholder. This value is the result of the function F, which takes all values and returns a single new value.
size(X1::clock()) -> non_neg_integer()
Returns the total number of values in this clock set.
Synchronizes a list of clocks using sync/2. It discards (causally) outdated values, while merging all causal histories.
Advances the causal history with the given id. The new value is the *anonymous dot* of the clock. The client clock SHOULD BE a direct result of new/2.
Advances the causal history of the first clock with the given id, while synchronizing with the second clock, thus the new clock is causally newer than both clocks in the argument. The new value is the *anonymous dot* of the clock. The first clock SHOULD BE a direct result of new/2, which is intended to be the client clock with the new value in the *anonymous dot* while the second clock is from the local server.
Returns all the values used in this clock set, including the anonymous values.
Generated by EDoc