net.algart.arrays.CharStack Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algart Show documentation

Open-source Java libraries, supporting generalized smart arrays and matrices with elements of any types, including a wide set of 2D-, 3D- and multidimensional image processing and other algorithms, working with arrays and matrices.

The newest version!

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2007-2024 Daniel Alievsky, AlgART Laboratory (http://algart.net)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package net.algart.arrays;

/*Repeat(INCLUDE_FROM_FILE, FloatStack.java, all)
  Float(?!ing) ==> Char ;;
  float ==> char
     !! Auto-generated: NOT EDIT !! */
/**
 * Stack of char values.
 *
 * @author Daniel Alievsky
 */
public interface CharStack extends Stack {
    /**
     * Removes the element at the top of this stack and returns its value,
     * or throws EmptyStackException if the stack is empty.
     *
     * It this object is an AlgART char array, implementing {@link MutableCharArray} interface,
     * and it is not empty, the same action may be performed by the following code:
     *      * char result = charArray.{@link CharArray#getChar(long) getChar}(charArray.{@link #length() length()}-1);
     * charArray.{@link MutableArray#length(long) length}(charArray.{@link #length() length()}-1);
     * 
     *
     * @return the element at the top of this stack (it is removed from the stack by this method).
     * @throws java.util.EmptyStackException if this stack is empty.
     */
    char popChar();

    /**
     * Appends value element to the end of this stack.
     *
     * It this object is an AlgART char array, implementing {@link MutableCharArray} interface,
     * the same action may be performed by the following code:
     *      * charArray.{@link MutableCharArray#length(long) length}(charArray.{@link #length() length()}+1);
     * charArray.{@link UpdatableCharArray#setChar(long, char)
     * setChar}(charArray.{@link #length() length()}-1, value);
     * 
     *
     * @param value to be added to the top of this stack.
     * @throws TooLargeArrayException if the resulting stack length is too large for this type of stacks.
     */
    void pushChar(char value);
/*Repeat.IncludeEnd*/
}