com.anrisoftware.globalpom.math.arraysminmax.ArrayMinMax Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of globalpomutils-math Show documentation

Mathematical classes.

There is a newer version: 4.7.0

/*
 * Copyright ${project.custom.year} Erwin Müller 
 *
 * 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.anrisoftware.globalpom.math.arraysminmax;

/*-
 * #%L
 * Global POM Utilities :: Math
 * %%
 * Copyright (C) 2013 - 2018 Advanced Natural Research Institute
 * %%
 * 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.
 * #L%
 */

import java.util.concurrent.Callable;

/**
 * Returns the min/max of a given array.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface ArrayMinMax extends Callable {

    /**
     * Returns the minimum value of the array.
     * 
     * @return the minimum value.
     */
    Number getMin();

    /**
     * Returns the maximum value of the array.
     * 
     * @return the maximum value.
     */
    Number getMax();

    /**
     * Calculates the min/max of a given array.
     */
    @Override
    ArrayMinMax call();
}