com.landawn.abacus.util.IntPair Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
There is a newer version: 5.2.4
/*
 * Copyright (C) 2018 HaiYang Li
 *
 * 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 com.landawn.abacus.util;

import com.landawn.abacus.annotation.Beta;
import com.landawn.abacus.annotation.SuppressFBWarnings;
import com.landawn.abacus.util.u.Optional;
import com.landawn.abacus.util.stream.IntStream;

/**
 *
 * @author Haiyang Li
 * @since 1.2
 */
@Beta
@com.landawn.abacus.annotation.Immutable
public final class IntPair implements Immutable {

    public final int _1; //NOSONAR
    public final int _2; //NOSONAR

    IntPair() {
        this(0, 0);
    }

    IntPair(int _1, int _2) {
        this._1 = _1;
        this._2 = _2;
    }

    /**
     *
     * @param _1 the 1
     * @param _2 the 2
     * @return
     */
    public static IntPair of(int _1, int _2) {
        return new IntPair(_1, _2);
    }

    /**
     * 
     *
     * @return 
     */
    public int min() {
        return N.min(_1, _2);
    }

    /**
     * 
     *
     * @return 
     */
    public int max() {
        return N.max(_1, _2);
    }

    /**
     * 
     *
     * @return 
     */
    public int sum() {
        return _1 + _2;
    }

    /**
     * 
     *
     * @return 
     */
    public double average() {
        return ((double) sum()) / 2;
    }

    /**
     * 
     *
     * @return 
     */
    public IntPair reverse() {
        return new IntPair(_2, _1);
    }

    /**
     *
     * @param 
     * @param comsumer
     * @throws E the e
     */
    public  void forEach(Throwables.IntConsumer comsumer) throws E {
        comsumer.accept(this._1);
        comsumer.accept(this._2);
    }

    /**
     *
     * @param 
     * @param action
     * @throws E the e
     */
    public  void accept(Throwables.IntBiConsumer action) throws E {
        action.accept(_1, _2);
    }

    /**
     *
     * @param 
     * @param 
     * @param mapper
     * @return
     * @throws E the e
     */
    public  U map(Throwables.IntBiFunction mapper) throws E {
        return mapper.apply(_1, _2);
    }

    /**
     *
     * @param 
     * @param predicate
     * @return
     * @throws E the e
     */
    public  Optional filter(final Throwables.IntBiPredicate predicate) throws E {
        return predicate.test(_1, _2) ? Optional.of(this) : Optional. empty();
    }

    /**
     * 
     *
     * @return 
     */
    public IntStream stream() {
        return IntStream.of(_1, _2);
    }

    /**
     * 
     *
     * @return 
     */
    @Override
    public int hashCode() {
        return 31 * _1 + this._2;
    }

    /**
     *
     * @param obj
     * @return
     */
    @SuppressFBWarnings
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        } else if (!(obj instanceof IntPair other)) {
            return false;
        } else {
            return this._1 == other._1 && this._2 == other._2;
        }
    }

    /**
     * 
     *
     * @return 
     */
    @Override
    public String toString() {
        return "[" + this._1 + ", " + this._2 + "]";
    }
}