001/*
002 * Copyright (c) 2015-2020, Oracle and/or its affiliates. All rights reserved.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.tribuo.classification.sgd.crf;
018
019/**
020 * Chunk class used for chunk level confidence prediction in the {@link CRFModel}.
021 */
022public class Chunk {
023    /**
024     * The starting point of this chunk.
025     */
026    public final int begin;
027    /**
028     * The labels for the next labels.length values.
029     */
030    public final int[] labels;
031
032    /**
033     * Constructs a chunk.
034     * @param begin The starting point of this chunk.
035     * @param labels The chunk labels.
036     */
037    public Chunk(int begin, int[] labels) {
038        this.begin = begin;
039        this.labels = labels;
040    }
041
042    /**
043     * Copies the labels into the constraints array starting at {@link #begin}.
044     * @param constraints The constraints array.
045     */
046    public void unpack(int[] constraints) {
047        System.arraycopy(labels, 0, constraints, begin, labels.length);
048    }
049}