/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ejml.masks;

/**
 * Helper class to build {@link Mask} and specify specific parameter
 *
 * @param <MASK> Type of Mask to return
 */
public abstract class MaskBuilder<MASK extends Mask> {
    protected boolean negated = false;

    /**
     * @param negated whether the build mask should negate its entries
     */
    public MaskBuilder<MASK> withNegated( boolean negated ) {
        this.negated = negated;
        return this;
    }

    /**
     * Build the mask based on the previously specified parameters
     */
    public abstract MASK build();
}
