aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/util/IMultiset.java
blob: bdd5d597ad649485f717f14f20b1c3e9bf0110e0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*******************************************************************************
 * Copyright (c) 2010-2017, Gabor Bergmann, IncQueryLabs Ltd.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-v20.html.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/
package tools.refinery.viatra.runtime.matchers.util;

/**
 * An {@link IMemory} that always contains values with a nonnegative multiplicity.
 * 
 * <p> In case a write operation caused underflow, an {@link IllegalStateException} is thrown.
 * 
 * @author Gabor Bergmann
 * @since 1.7
 */
public interface IMultiset<T> extends IMemory<T> {

    /**
     * Adds the given number of occurrences to the memory. The count value must be a positive number.
     * 
     * @param count
     *            the number of occurrences
     * @return true if the tuple was not present before in the memory
     */
    boolean addPositive(T value, int count);
    
}