io.github.palexdev.mfxcore.base.beans.range.IntegerRange Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation
Material Design/Modern components for JavaFX, now packed as a single Jar
There is a newer version: 11.26.0
/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
 *
 * MaterialFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX. If not, see .
 */

package io.github.palexdev.mfxcore.base.beans.range;

import java.util.*;
import java.util.stream.IntStream;

/**
 * Implementation of {@link NumberRange} to represent an Integer range.
 */
public class IntegerRange extends NumberRange implements Iterable {

	//================================================================================
	// Constructors
	//================================================================================
	public IntegerRange(Integer min, Integer max) {
		super(min, max);
	}

	//================================================================================
	// Static Methods
	//================================================================================

	/**
	 * @return a new instance of {@code IntegerRange} with the given min and max bounds.
	 */
	public static IntegerRange of(Integer min, Integer max) {
		return new IntegerRange(min, max);
	}

	/**
	 * @return a new instance of {@code IntegerRange} with the given val as both min and max bounds.
	 */
	public static IntegerRange of(Integer val) {
		return new IntegerRange(val, val);
	}

	/**
	 * Checks if the given value is contained in the given range (bounds are included).
	 */
	public static boolean inRangeOf(int val, IntegerRange range) {
		return Math.max(range.getMin(), val) == Math.min(val, range.getMax());
	}

	/**
	 * Expands a range of integers to a {@code List} with step=1.
	 */
	public static List expandRange(IntegerRange range) {
		return IntStream.rangeClosed(range.getMin(), range.getMax()).collect(ArrayList::new, List::add, List::addAll);
	}

	/**
	 * Expands a range of integers to a {@code List} with the given step.
	 */
	public static List expandRange(IntegerRange range, int step) {
		List l = new ArrayList<>();
		int start = range.getMin();
		do {
			l.add(start);
			start += step;
		} while (start <= range.getMax());
		return l;
	}

	/**
	 * Expands a range of integers to a {@code Set} with step=1.
	 * 
	 * The {@code Set} is ordered.
	 */
	public static Set expandRangeToSet(IntegerRange range) {
		return IntStream.rangeClosed(range.getMin(), range.getMax()).collect(LinkedHashSet::new, Set::add, Set::addAll);
	}

	/**
	 * Expands a range of integers to a {@code Set} with the given step.
	 * 
	 * The {@code Set} is ordered.
	 */
	public static Set expandRangeToSet(IntegerRange range, int step) {
		Set s = new LinkedHashSet<>();
		int start = range.getMin();
		do {
			s.add(start);
			start += step;
		} while (start <= range.getMax());
		return s;
	}

	/**
	 * Expands a range of integers to an array.
	 */
	public static Integer[] expandRangeToArray(int min, int max) {
		return expandRange(of(min, max)).toArray(Integer[]::new);
	}

	//================================================================================
	// Overridden Methods
	//================================================================================
	@Override
	public Integer sum() {
		return getMin() + getMax();
	}

	@Override
	public Integer diff() {
		return getMax() - getMin();
	}

	@Override
	public PrimitiveIterator.OfInt iterator() {
		return IntStream.rangeClosed(getMin(), getMax()).iterator();
	}
}