com.metreeca.text.Range Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metreeca-text Show documentation
A lightweight NLP framework.
The newest version!
/*
 * Copyright © 2013-2022 Metreeca srl
 *
 * 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.metreeca.text;

import static java.lang.Integer.max;
import static java.lang.Integer.min;

public interface Range {

	public int lower();

	public int upper();


	public default int offset() {
		return lower();
	}

	public default int length() {
		return upper()-lower();
	}


	////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

	public default boolean matches(final Range range) {

		if ( range == null ) {
			throw new NullPointerException("null range");
		}

		return lower() == range.lower() && upper() == range.upper();
	}

	public default boolean contains(final Range range) {

		if ( range == null ) {
			throw new NullPointerException("null range");
		}

		return lower() <= range.lower() && upper() >= range.upper();
	}

	public default boolean dominates(final Range range) {

		if ( range == null ) {
			throw new NullPointerException("null range");
		}

		return !matches(range) && contains(range);
	}

	public default boolean borders(final Range range) {

		if ( range == null ) {
			throw new NullPointerException("null range");
		}

		return max(lower(), range.lower()) == min(upper(), range.upper());
	}

	public default boolean intersects(final Range range) {

		if ( range == null ) {
			throw new NullPointerException("null range");
		}

		return max(lower(), range.lower()) < min(upper(), range.upper());
	}

}