mercurylang/mercury
1
0
Fork 0
mirror of https://github.com/Mercury-Language/mercury.git synced 2026-04-19 03:13:40 +00:00
Code Issues Projects Releases Wiki Activity
Files
dadf30718d6084962be37dae8b94de41aaee90e2
mercury/library/multi_map.m
Zoltan Somogyi 63dabcfcf8 Fix filling in partial terms that use direct_arg tags. 
This fix uses the approach discussed on m-dev 2020 nov 16/17 for fixing
github issue #72, whose core problem is a need for information flow
back to a the caller from a callee when the callee fills in the
argument of a function symbol whose representation is a direct_arg tag.
In most cases when the callee fills in the value of an argument,
the caller can see it because the argument is in a word on the heap,
but when the function symbol uses a direct_arg tag, that is not the case.

compiler/direct_arg_in_out.m:
    A new module that implements the transformation proposed on m-dev.
    It creates a fresh clone variable every time an argument of a direct_arg
    tag function symbol is (or may be) updated. This can happen several
    times if a type has more than one function symbol with a direct_arg tag.
    Since the affected variable can be bound to only one function symbol
    at the start, its argument can be filled in only once, but the
    compiler cannot know in advance what function symbol the variable
    contains, and therefore which of the possibly several fill-in sites
    (which fill in the arguments of different function symbols) executed
    in sequence will actually update the variable.

    The transformation ensures that once a variable is cloned, it is
    never referred to again. It also ensures that in a branched control
    structure (if-then-else, disjunction or switch), all branches will use
    the *same* variable to represent the latest version of each cloned
    variable at the end, so that following code has a consistent view
    regardless of through which branch execution has reached it.

    There are three situations that the transformation cannot and does not
    handle.

    1. Situations in which the mode of an argument is either an inst variable,
       or an abstract inst. In either case, the pass cannot know whether
       it should apply its transformation to the argument.

    2. Situations where a procedure that has such an argument is
       exported to C code as a function. In that case, the C signature
       of the function we would generate would be different from what
       the user would normally expect. We could modify the documentation
       of the export pragma, but I don't think there much point due to
       lack of demand. (The problem cannot arise when targeting any language
       other than C, because we use direct_arg tags only with the low level
       data representation, which we only use for C.)

    3. Situations where a procedure that has such an argument is defined
       by foreign_proc. Again, dealing with the problem would require
       nontrivial changes to the documented interface between code in
       foreign_procs and the surrounding Mercury code, and I see no demand
       for code that could benefit from that.

    In these cases, this module generates error messages.

compiler/transform_hlds.m:
    Include the new module in the transform_hlds package.

    Delete unnecessary module qualification on some existing inclusions.
    Put some existing inclusions into a more meaningful order.

compiler/notes/compiler_design.html:
    Document the new pass. Fix some nearby prose.

compiler/lambda.m:
compiler/simplify_proc.m:
    Use a predicate exported by direct_arg_in_out.m to test, for each
    procedure, whether the procedure has any argument positions that are
    subject to the problem that direct_arg_in_out.m addresses.
    simplify_proc.m does this for all procedures it processes;
    lambda.m does this for all the procedures it creates from
    lambda expressions.

    Give a predicate in simplify_proc.m a better name.

    Sort a list of predicate names.

compiler/hlds_module.m:
    Add a field to the module_info that simplify_proc.m and lambda.m
    can use to tell direct_arg_in_out.m what work (if any) it needs to do.

compiler/mercury_compile_middle_passes.m:
    Invoke direct_arg_in_out.m if the new field in the HLDS indicates
    that it has some work to do. (In the vast majority of compiler invocations,
    it won't have any.)

compiler/hlds_pred.m:
    The new code in direct_arg_in_out.m creates a clone of each procedure
    affected by the problem, before deleting the originals (to make sure that
    no references to the unfixed versions of now-fixed procedures remain.)
    Make it possible to create exact clones of both predicates and procedures
    by adding two pairs of predicates, {pred,proc}_prepare_to_clone and
    {pred,proc}_create.

    Add the direct_arg_in_out transformation as a possible source
    of transformed predicates.

library/private_builtin.m:
    Add a new builtin operation, partial_inst_copy, that the new module
    generates calls to.

configure.ac:
    Require the installed compiler to recognize partial_inst_copy
    as a no_type_info builtin.

compiler/builtin_ops.m:
    Recognize the new builtin. (This was committed before the rest; the diff
    to private_builtin.m can be done only once the change to builtin_ops.m
    is part of the installed compiler.)

compiler/options.m:
    Add a way to test whether the builtin_ops.m in the installed compiler
    recognizes the new builtin.

compiler/dead_proc_elim.m:
    Do not delete the new primitive before direct_arg_in_out.m has had
    a chance to generate calls to it.

    Add an XXX.

compiler/error_util.m:
    Recognize the new module as a source of error messages.

compiler/pred_table.m:
    Add a pair of utility predicates to be used when looking up
    builtin predicates, for which the compiler writer knows that
    there should be exactly one match. These are used in direct_arg_in_out.m.

compiler/simplify_goal_call.m:
    Replace some existing code with calls to the new predicates
    in pred_table.m.

compiler/hlds_goal.m:
    Add modes to rename_vars_in_goal_expr that express the fact
    that when an atomic goal_expr has some variables renamed inside it,
    it does not suddenly become some *other* kind of goal_expr.
    New code in direct_arg_in_out.m relies on this.

compiler/hlds_out_goal.m:
    When the HLDS we are dumping out is malformed because it contains
    calls to predicates that have been deleted, the compiler used to abort
    at such calls. (I ran into this while debugging direct_arg_in_out.m.)

    Fix this. When such calls are encountered, we now print out as much
    information we can about the call, and prefix the call with an
    unmistakable prefix to draw attention to the problem.

compiler/inst_util.m:
    Fix a bug that prevented direct_arg_in_out.m from even being invoked
    on some test code for it.

    The bug was in code that we use to unify a headvar's initial inst
    with its final inst. When the initial inst was a non-ground bound_inst
    such as the ones used in tests/hard_coded/gh72.m, and the final inst
    was simply "ground", this code quite properly returned a bound_inst
    (which, unlike ground, can show the exact set of function symbols
    that the headvar could be bound to). The problem was that it
    reused the original bound_inst's test results, including the one
    that said the final inst is NOT ground, which of course is wrong
    for any inst unified with ground. Fix two instances of this bug.

compiler/modes.m:
    Make some of the code I had to traverse to find the bug in inst_util.m
    easier to read and understand.

    Replace some uses of booleans with bespoke enum types.

    Change the argument lists of some predicates to put related arguments
    next to each other.

    Give some variables more descriptive names.

compiler/layout_out.m:
    Conform to the change in hlds_pred.m.

compiler/var_locn.m:
    Fix a code generation bug. When filling-in the value of the argument
    of a function symbol represented by a direct_arg tag, the code we
    generated for it worked only if the direct_arg tag used 0
    as its ptag value. In the test cases we initially used for
    github issue 72, that was the case, but the new tests/hard_coded/gh72.m
    has direct_tag args that use other ptag values as well.

    Document the reason why the updated code works.

compiler/term_constr_initial.m:
    Add the new primitive predicate added to private_builtin.m,
    partial_inst_copy, to a table of builtins that do not take type_infos,
    even though their signatures contain type variables.

    Fix a bunch of old bugs: most other such primitives were not listed
    either.

mdbcomp/program_representation.m:
    Add partial_inst_copy to the master list of builtins that do not take
    type_infos even though their signatures contain type variables. (Done
    by an earlier commit.)

    Document the fact that any updates here require updates to
    term_constr_initial.m.

library/multi_map.m:
    We have long had multi_map.add and multi_map.set as synonyms,
    but we only had multi_map.reverse_set. Add multi_map.reverse_add
    as a synonym for it.

    Define the "set" versions in terms of the "add" versions,
    instead of vice versa.

NEWS:
    Document the new predicates in multi_map.m.

tests/hard_coded/gh72a.m:
    Fix typo.

tests/hard_coded/gh72.{m,exp}:
    A new, much more comprehensive test case than gh72a.m.
    This one tries to tickle github issue 72 in as many forms of code
    as I can think of.

tests/invalid/gh72_errors.{m,err_exp}:
    A test case for testing the generation of error messages for
    two out of the three kinds of situations that direct_arg_in_out.m
    cannot handle. (Proposals for how to test the third category welcome.)

tests/hard_coded/Mmakefile:
tests/invalid/Mmakefile:
    Enable the two new test cases, as well as two old ones, gh72[ab].m,
    that previously we didn't pass.

tests/invalid/Mercury.option:
    Do not compile gh72_error.m with --errorcheck-only, since its errors
    are reported by a pass that --errorcheck-only does not invoke.
2021-01-13 05:35:40 +11:00

676 lines
22 KiB
Mathematica
Raw Blame History

%---------------------------------------------------------------------------%
% vim: ts=4 sw=4 et ft=mercury
%---------------------------------------------------------------------------%
% Copyright (C) 1995, 1997, 2000, 2002-2006, 2011 The University of Melbourne.
% Copyright (C) 2014-2018 The Mercury team.
% This file is distributed under the terms specified in COPYING.LIB.
%---------------------------------------------------------------------------%
%
% File: multi_map.m.
% Main author: dylan.
% Stability: medium.
%
% This file provides the 'multi_map' ADT.
% A map (also known as a dictionary or an associative array) is a collection
% of (Key, Value) pairs which allows you to look up any Value given the Key.
% A multi_map is similar, but it allows more than one Value for each Key.
%
% This is implemented almost as a special case of map.m.
%
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
:- module multi_map.
:- interface.
:- import_module assoc_list.
:- import_module list.
:- import_module map.
:- import_module set.
%---------------------------------------------------------------------------%
:- type multi_map(K, V) == map(K, list(V)).
%---------------------------------------------------------------------------%
% Return an empty multi_map.
%
:- func init = multi_map(_K, _V).
:- pred init(multi_map(_K, _V)::uo) is det.
% Check whether the multi_map is empty.
%
:- pred is_empty(multi_map(_K, _V)::in) is semidet.
%---------------------%
% Check whether the multi_map has an entry for the given key.
%
:- pred contains(multi_map(K, _V)::in, K::in) is semidet.
% Succeed once for each key-value pair in the multi_map.
%
:- pred member(multi_map(K, V)::in, K::out, V::out) is nondet.
% If the multi_map has an entry for the given key, return the
% list of corresponding values.
%
:- pred search(multi_map(K, V)::in, K::in, list(V)::out) is semidet.
% If the multi_map has an entry for the given key,
% succeed once for each of the corresponding values.
%
:- pred nondet_search(multi_map(K, V)::in, K::in, V::out) is nondet.
% If the multi_map has an entry for the given key,
% succeed once for each of the corresponding values.
% Otherwise, throw an exception.
%
:- func lookup(multi_map(K, V), K) = list(V).
:- pred lookup(multi_map(K, V)::in, K::in, list(V)::out) is det.
% If the multi_map has an entry for the given key,
% succeed once for each of the corresponding values.
% Otherwise, throw an exception.
%
:- pred nondet_lookup(multi_map(K, V)::in, K::in, V::out) is nondet.
% If the multi_map has an entry for keys with the given value,
% succeed once for each of those keys.
%
% NOTE: The implementation of this predicate is necessarily inefficient,
% and so this predicate is intended for non-performance-critical uses only.
%
:- pred inverse_search(multi_map(K, V)::in, V::in, K::out) is nondet.
%---------------------%
% Add the given key-value pair to the multi_map.
% Fail if the key already exists.
%
:- pred insert(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is semidet.
% Add the given key-value pair to the multi_map.
% Throw an exception if the key already exists.
%
:- func det_insert(multi_map(K, V), K, V) = multi_map(K, V).
:- pred det_insert(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Add the given key-value pair to the multi_map.
% Fail if the key does not already exist.
%
:- pred update(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is semidet.
% Add the given key-value pair to the multi_map.
% Throw an exception if the key does not already exist.
%
:- func det_update(multi_map(K, V), K, V) = multi_map(K, V).
:- pred det_update(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Replace the list of values corresponding to the given key.
% Fails if the key does not already exist.
%
:- pred replace(K::in, list(V)::in,
multi_map(K, V)::in, multi_map(K, V)::out) is semidet.
% Replace the list of values corresponding to the given key.
% Throws an exception if the key does not already exist.
%
:- func det_replace(multi_map(K, V), K, list(V)) = multi_map(K, V).
:- pred det_replace(K::in, list(V)::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Add the given key-value pair to the multi_map.
% (`set' is a synonym for `add'.)
%
:- func add(multi_map(K, V), K, V) = multi_map(K, V).
:- pred add(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
:- func set(multi_map(K, V), K, V) = multi_map(K, V).
:- pred set(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Add the given value-key pair to the multi_map.
% (`reverse_set' is a synonym for `reverse_add'.)
%
:- func reverse_add(multi_map(K, V), V, K) = multi_map(K, V).
:- pred reverse_add(V::in, K::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
:- func reverse_set(multi_map(K, V), V, K) = multi_map(K, V).
:- pred reverse_set(V::in, K::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
%---------------------%
% Delete a key and its corresponding values from a multi_map.
% If the key is not present, leave the multi_map unchanged.
%
:- func delete(multi_map(K, V), K) = multi_map(K, V).
:- pred delete(K::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Delete the given key-value pair from a multi_map.
% If the key-value pair is not present, leave the multi_map unchanged.
%
:- func delete(multi_map(K, V), K, V) = multi_map(K, V).
:- pred delete(K::in, V::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Delete a key from a multi_map and return the list of values
% previously corresponding to it.
% Fail if the key is not present.
%
:- pred remove(K::in, list(V)::out,
multi_map(K, V)::in, multi_map(K, V)::out) is semidet.
% Delete a key from a multi_map and return the list of values
% previously corresponding to it.
% Throw an exception if the key is not present.
%
:- pred det_remove(K::in, list(V)::out,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
% Remove the smallest key and its corresponding values from the multi_map.
% Fails if the multi_map is empty.
%
:- pred remove_smallest(K::out, list(V)::out,
multi_map(K, V)::in, multi_map(K, V)::out) is semidet.
%---------------------%
% Select takes a multi_map and a set of keys and returns a multi_map
% containing only the keys in the set, together with their corresponding
% values.
%
:- func select(multi_map(K, V), set(K)) = multi_map(K, V).
:- pred select(multi_map(K, V)::in, set(K)::in, multi_map(K, V)::out) is det.
%---------------------%
% merge(MultiMapA, MultiMapB, MultiMap):
%
% Merge `MultiMapA' and `MultiMapB' so that
%
% - if a key occurs in both `MultiMapA' and `MultiMapB', then the values
% corresponding to that key in `MultiMap' will be the concatenation
% of the values to that key from `MultiMapA' and `MultiMapB'; while
% - if a key occurs in only one of `MultiMapA' and `MultiMapB', then
% the values corresponding to it in that map will be carried over
% to `MultiMap'.
%
:- func merge(multi_map(K, V), multi_map(K, V))
= multi_map(K, V).
:- pred merge(multi_map(K, V)::in, multi_map(K, V)::in,
multi_map(K, V)::out) is det.
%---------------------%
% Declaratively, a no-operation.
% Operationally, a suggestion that the implementation optimize
% the representation of the multi_map, in the expectation that the
% following operations will consist of searches and lookups
% but (almost) no updates.
%
:- func optimize(multi_map(K, V)) = multi_map(K, V).
:- pred optimize(multi_map(K, V)::in, multi_map(K, V)::out) is det.
%---------------------%
% Convert a multi_map to an association list.
%
:- func to_flat_assoc_list(multi_map(K, V)) = assoc_list(K, V).
:- pred to_flat_assoc_list(multi_map(K, V)::in,
assoc_list(K, V)::out) is det.
% Convert an association list to a multi_map.
%
:- func from_flat_assoc_list(assoc_list(K, V)) = multi_map(K, V).
:- pred from_flat_assoc_list(assoc_list(K, V)::in,
multi_map(K, V)::out) is det.
% Convert a multi_map to an association list, with all the values
% for each key in one element of the association list.
%
:- func to_assoc_list(multi_map(K, V)) = assoc_list(K, list(V)).
:- pred to_assoc_list(multi_map(K, V)::in,
assoc_list(K, list(V))::out) is det.
% Convert an association list with all the values for each key
% in one element of the list to a multi_map.
%
:- func from_assoc_list(assoc_list(K, list(V))) = multi_map(K, V).
:- pred from_assoc_list(assoc_list(K, list(V))::in,
multi_map(K, V)::out) is det.
% Convert a sorted association list to a multi_map.
%
:- func from_sorted_assoc_list(assoc_list(K, list(V)))
= multi_map(K, V).
:- pred from_sorted_assoc_list(assoc_list(K, list(V))::in,
multi_map(K, V)::out) is det.
% Convert the corresponding elements of a list of keys and a
% list of values (which must be of the same length) to a multi_map.
% A key may occur more than once in the list of keys.
% Throw an exception if the two lists are not the same length.
%
:- func from_corresponding_lists(list(K), list(V))
= multi_map(K, V).
:- pred from_corresponding_lists(list(K)::in, list(V)::in,
multi_map(K, V)::out) is det.
% Convert the corresponding elements of a list of keys and a
% *list of lists* of values to a multi_map.
% A key may *not* occur more than once in the list of keys.
% Throw an exception if the two lists are not the same length,
% or if a key does occur more than once in the list of keys.
%
:- func from_corresponding_list_lists(list(K), list(list(V)))
= multi_map(K, V).
:- pred from_corresponding_list_lists(list(K)::in, list(list(V))::in,
multi_map(K, V)::out) is det.
%---------------------%
% Given a list of keys, produce a list of their values in a
% specified multi_map.
%
:- func apply_to_list(list(K), multi_map(K, V)) = list(V).
:- pred apply_to_list(list(K)::in, multi_map(K, V)::in, list(V)::out) is det.
%---------------------%
% Given a multi_map, return a list of all the keys in it.
%
:- func keys(multi_map(K, V)) = list(K).
:- pred keys(multi_map(K, V)::in, list(K)::out) is det.
% Given a multi_map, return a list of all the keys in it
% in sorted order.
%
:- func sorted_keys(multi_map(K, V)) = list(K).
:- pred sorted_keys(multi_map(K, V)::in, list(K)::out) is det.
% Given a multi_map, return a list of all the keys in it
% as a set
%
:- func keys_as_set(multi_map(K, V)) = set(K).
:- pred keys_as_set(multi_map(K, V)::in, set(K)::out) is det.
% Given a multi_map, return a list of all the values in it.
%
:- func values(multi_map(K, V)) = list(V).
:- pred values(multi_map(K, V)::in, list(V)::out) is det.
%---------------------%
% Count the number of keys in the multi_map.
%
:- func count(multi_map(K, V)) = int.
:- pred count(multi_map(K, V)::in, int::out) is det.
% Count the number of key-value pairs in the multi_map.
%
:- func all_count(multi_map(K, V)) = int.
:- pred all_count(multi_map(K, V)::in, int::out) is det.
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
:- implementation.
:- import_module cord.
:- import_module int.
:- import_module pair.
:- import_module require.
%---------------------------------------------------------------------------%
init = MultiMap :-
multi_map.init(MultiMap).
init(MultiMap) :-
map.init(MultiMap).
is_empty(MultiMap) :-
map.is_empty(MultiMap).
%---------------------------------------------------------------------------%
contains(MultiMap, Key) :-
map.search(MultiMap, Key, _).
member(MultiMap, Key, Value) :-
map.member(MultiMap, Key, ValueList),
list.member(Value, ValueList).
search(MultiMap, Key, Values) :-
map.search(MultiMap, Key, Values).
nondet_search(MultiMap, Key, Value) :-
map.search(MultiMap, Key, Values),
list.member(Value, Values).
lookup(MultiMap, Key) = Value :-
multi_map.lookup(MultiMap, Key, Value).
lookup(MultiMap, Key, Values) :-
map.lookup(MultiMap, Key, Values).
nondet_lookup(MultiMap, Key, Value) :-
map.search(MultiMap, Key, Values),
list.member(Value, Values).
inverse_search(MultiMap, Value, Key) :-
map.member(MultiMap, Key, ValueList),
list.member(Value, ValueList).
%---------------------------------------------------------------------------%
insert(Key, Value, !MultiMap) :-
map.insert(Key, [Value], !MultiMap).
det_insert(!.MultiMap, Key, Value) = !:MultiMap :-
multi_map.det_insert(Key, Value, !MultiMap).
det_insert(Key, Value, !MultiMap) :-
map.det_insert(Key, [Value], !MultiMap).
update(Key, Value, !MultiMap) :-
map.search(!.MultiMap, Key, Values0),
Values = [Value | Values0],
map.update(Key, Values, !MultiMap).
det_update(!.MultiMap, Key, Value) = !:MultiMap :-
multi_map.det_update(Key, Value, !MultiMap).
det_update(Key, Value, !MultiMap) :-
( if multi_map.update(Key, Value, !MultiMap) then
true
else
report_lookup_error("multi_map.det_update: key not found", Key)
).
replace(Key, Value, !MultiMap) :-
map.update(Key, Value, !MultiMap).
det_replace(!.MultiMap, Key, Values) = !:MultiMap :-
multi_map.det_replace(Key, Values, !MultiMap).
det_replace(Key, Values, !MultiMap) :-
map.det_update(Key, Values, !MultiMap).
add(!.MultiMap, Key, Value) = !:MultiMap :-
multi_map.add(Key, Value, !MultiMap).
add(Key, Value, !MultiMap) :-
( if map.search(!.MultiMap, Key, Values0) then
Values = [Value | Values0],
map.det_update(Key, Values, !MultiMap)
else
map.det_insert(Key, [Value], !MultiMap)
).
set(!.MultiMap, Key, Value) = !:MultiMap :-
multi_map.add(Key, Value, !MultiMap).
set(Key, Value, !MultiMap) :-
multi_map.add(Key, Value, !MultiMap).
reverse_add(!.MultiMap, Value, Key) = !:MultiMap :-
multi_map.add(Key, Value, !MultiMap).
reverse_add(Value, Key, !MultiMap) :-
multi_map.add(Key, Value, !MultiMap).
reverse_set(!.MultiMap, Value, Key) = !:MultiMap :-
multi_map.add(Key, Value, !MultiMap).
reverse_set(Value, Key, !MultiMap) :-
multi_map.add(Key, Value, !MultiMap).
%---------------------------------------------------------------------------%
delete(!.MultiMap, Key) = !:MultiMap :-
multi_map.delete(Key, !MultiMap).
delete(Key, !MultiMap) :-
map.delete(Key, !MultiMap).
delete(!.MultiMap, Key, Value) = !:MultiMap :-
multi_map.delete(Key, Value, !MultiMap).
delete(Key, Value, !MultiMap) :-
( if
map.search(!.MultiMap, Key, Values0),
list.delete_all(Values0, Value, Values)
then
(
Values = [],
map.delete(Key, !MultiMap)
;
Values = [_ | _],
map.det_update(Key, Values, !MultiMap)
)
else
true
).
remove(MultiMap0, Key, Values, MultiMap) :-
map.remove(MultiMap0, Key, Values, MultiMap).
det_remove(MultiMap0, Key, Values, MultiMap) :-
map.det_remove(MultiMap0, Key, Values, MultiMap).
remove_smallest(MultiMap0, Key, Values, MultiMap) :-
map.remove_smallest(MultiMap0, Key, Values, MultiMap).
%---------------------------------------------------------------------------%
select(MultiMap0, KeySet) = MultiMap :-
multi_map.select(MultiMap0, KeySet, MultiMap).
select(MultiMap0, KeySet, MultiMap) :-
map.select(MultiMap0, KeySet, MultiMap).
%---------------------------------------------------------------------------%
merge(MultiMapA, MultiMapB) = MultiMap :-
multi_map.merge(MultiMapA, MultiMapB, MultiMap).
merge(M0, M1, M) :-
multi_map.to_assoc_list(M0, ML0),
multi_map.to_assoc_list(M1, ML1),
multi_map.assoc_list_merge(ML0, ML1, ML),
multi_map.from_sorted_assoc_list(ML, M).
:- pred multi_map.assoc_list_merge(assoc_list(K, list(V))::in,
assoc_list(K, list(V))::in, assoc_list(K, list(V))::out) is det.
assoc_list_merge(ListA, ListB, List) :-
(
ListA = [],
List = ListB
;
ListA = [HeadA | TailA],
(
ListB = [],
List = ListA
;
ListB = [HeadB | TailB],
HeadA = KeyA - ValuesA,
HeadB = KeyB - ValuesB,
compare(Res, KeyA, KeyB),
(
Res = (<),
Key = KeyA,
Values = ValuesA,
multi_map.assoc_list_merge(TailA, ListB, Tail)
;
Res = (=),
Key = KeyA,
list.append(ValuesA, ValuesB, Values),
multi_map.assoc_list_merge(TailA, TailB, Tail)
;
Res = (>),
Key = KeyB,
Values = ValuesB,
multi_map.assoc_list_merge(ListA, TailB, Tail)
),
List = [Key - Values | Tail]
)
).
%---------------------------------------------------------------------------%
optimize(MultiMap0) = MultiMap :-
multi_map.optimize(MultiMap0, MultiMap).
optimize(MultiMap0, MultiMap) :-
map.optimize(MultiMap0, MultiMap).
%---------------------------------------------------------------------------%
to_flat_assoc_list(MultiMap) = AssocList :-
multi_map.to_flat_assoc_list(MultiMap, AssocList).
to_flat_assoc_list(MultiMap, AssocList) :-
map.foldl(to_flat_assoc_list_acc, MultiMap, cord.init, Cord),
AssocList = cord.list(Cord).
:- pred to_flat_assoc_list_acc(K::in, list(V)::in,
cord(pair(K, V))::in, cord(pair(K, V))::out) is det.
to_flat_assoc_list_acc(Key, Values, !Cord) :-
KeyValues = list.map((func(Value) = Key - Value), Values),
!:Cord = !.Cord ++ cord.from_list(KeyValues).
%---------------------%
from_flat_assoc_list(AssocList) = MultiMap :-
multi_map.from_flat_assoc_list(AssocList, MultiMap).
from_flat_assoc_list(AssocList, MultiMap) :-
list.foldl(multi_map.add_from_pair, AssocList, map.init, MultiMap).
:- pred multi_map.add_from_pair(pair(K, V)::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
add_from_pair(K - V, !MultiMap) :-
multi_map.add(K, V, !MultiMap).
%---------------------%
to_assoc_list(MultiMap) = AssocList :-
multi_map.to_assoc_list(MultiMap, AssocList).
to_assoc_list(MultiMap, AssocList) :-
map.to_assoc_list(MultiMap, AssocList).
from_assoc_list(AssocList) = MultiMap :-
multi_map.from_assoc_list(AssocList, MultiMap).
from_assoc_list(AssocList, MultiMap) :-
map.from_assoc_list(AssocList, MultiMap).
from_sorted_assoc_list(AssocList) = MultiMap :-
multi_map.from_sorted_assoc_list(AssocList, MultiMap).
from_sorted_assoc_list(AssocList, MultiMap) :-
map.from_sorted_assoc_list(AssocList, MultiMap).
%---------------------%
from_corresponding_lists(Keys, Values) = MultiMap :-
multi_map.from_corresponding_lists(Keys, Values, MultiMap).
from_corresponding_lists(Keys, Values, MultiMap) :-
multi_map.init(MultiMap0),
multi_map.from_corresponding_lists_2(Keys, Values, MultiMap0, MultiMap).
:- pred multi_map.from_corresponding_lists_2(list(K)::in, list(V)::in,
multi_map(K, V)::in, multi_map(K, V)::out) is det.
from_corresponding_lists_2([], [], !MultiMap).
from_corresponding_lists_2([], [_ | _], !MultiMap) :-
unexpected("from_corresponding_lists", "list length mismatch").
from_corresponding_lists_2([_ | _], [], !MultiMap) :-
unexpected("from_corresponding_lists", "list length mismatch").
from_corresponding_lists_2([Key | Keys], [Value | Values], !MultiMap) :-
multi_map.add(Key, Value, !MultiMap),
multi_map.from_corresponding_lists_2(Keys, Values, !MultiMap).
%---------------------%
from_corresponding_list_lists(Keys, Values) = MultiMap :-
multi_map.from_corresponding_list_lists(Keys, Values, MultiMap).
from_corresponding_list_lists(Keys, Values, MultiMap) :-
map.from_corresponding_lists(Keys, Values, MultiMap).
%---------------------------------------------------------------------------%
apply_to_list(Keys, MultiMap) = Values :-
multi_map.apply_to_list(Keys, MultiMap, Values).
apply_to_list([], _, []).
apply_to_list(Keys @ [_ | _], MultiMap, Values) :-
map.apply_to_list(Keys, MultiMap, ValueLists),
list.condense(ValueLists, Values).
%---------------------------------------------------------------------------%
keys(MultiMap) = Keys :-
multi_map.keys(MultiMap, Keys).
keys(MultiMap, Keys) :-
map.keys(MultiMap, Keys).
sorted_keys(Map) = Keys :-
map.sorted_keys(Map, Keys).
sorted_keys(Map, Keys) :-
map.sorted_keys(Map, Keys).
keys_as_set(Map) = KeySet :-
multi_map.keys_as_set(Map, KeySet).
keys_as_set(Map, KeySet) :-
multi_map.sorted_keys(Map, Keys),
set.sorted_list_to_set(Keys, KeySet).
values(MultiMap) = Values :-
multi_map.values(MultiMap, Values).
values(MultiMap, Values) :-
map.values(MultiMap, ValueLists),
list.condense(ValueLists, Values).
%---------------------------------------------------------------------------%
count(MultiMap0) = Count :-
multi_map.count(MultiMap0, Count).
count(MultiMap, Count) :-
map.count(MultiMap, Count).
all_count(MultiMap0) = Count :-
multi_map.all_count(MultiMap0, Count).
all_count(MultiMap, Count) :-
map.foldl_values(multi_map.accumulate_length, MultiMap, 0, Count).
:- pred accumulate_length(list(V)::in, int::in, int::out) is det.
accumulate_length(Vs, !Count) :-
list.length(Vs, NVs),
!:Count = !.Count + NVs.
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
Reference in New Issue View Git Blame Copy Permalink