    001package org.cpsolver.ifs.assignment.context;
    002
    003import org.cpsolver.ifs.assignment.Assignment;
    004
    005/**
    006 * An additional interface that can be implemented by the {@link HasAssignmentContext} class.
    007 * The assignment context holder (see {@link AssignmentContextHolder}) can than use this interface
    008 * to store assignment contexts directly on the {@link HasAssignmentContext} class, if the
    009 * assignment permits it (the {@link Assignment#getIndex()} is implemented, i.e., a non negative
    010 * index is returned).
    011 *
    012 * @see HasAssignmentContext
    013 *
    014 * @author  Tomáš Müller
    015 * @version IFS 1.3 (Iterative Forward Search)<br>
    016 *          Copyright (C) 2014 Tomáš Müller<br>
    017 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
    018 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
    019 * <br>
    020 *          This library is free software; you can redistribute it and/or modify
    021 *          it under the terms of the GNU Lesser General Public License as
    022 *          published by the Free Software Foundation; either version 3 of the
    023 *          License, or (at your option) any later version. <br>
    024 * <br>
    025 *          This library is distributed in the hope that it will be useful, but
    026 *          WITHOUT ANY WARRANTY; without even the implied warranty of
    027 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    028 *          Lesser General Public License for more details. <br>
    029 * <br>
    030 *          You should have received a copy of the GNU Lesser General Public
    031 *          License along with this library; if not see <a href='http://www.gnu.org/licenses'>http://www.gnu.org/licenses</a>.
    032 **/
    033public interface CanHoldContext {
    034    /**
    035     * Maximum number of assignment contexts to be held
    036     */
    037    public static int sMaxSize = 17;
    038
    039    /**
    040     * An array of {@link CanHoldContext#sMaxSize} assignment contexts
    041     * @return assignment contexts
    042     */
    043    public AssignmentContext[] getContext();
    044}