com.gs.collections.api.FloatIterable Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * 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.gs.collections.api;

import com.gs.collections.api.bag.primitive.MutableFloatBag;
import com.gs.collections.api.block.function.primitive.ObjectFloatToObjectFunction;
import com.gs.collections.api.block.function.primitive.FloatToObjectFunction;
import com.gs.collections.api.block.predicate.primitive.FloatPredicate;
import com.gs.collections.api.block.procedure.primitive.FloatProcedure;
import com.gs.collections.api.iterator.FloatIterator;
import com.gs.collections.api.list.primitive.MutableFloatList;
import com.gs.collections.api.set.primitive.MutableFloatSet;

/**
 * FloatIterable is an interface which is memory-optimized for float primitives.
 * It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc.
 * The API also includes an external iterator method, which returns an FloatIterator. FloatIterator helps iterate over the FloatIterable without boxing the primitives.
 * This file was automatically generated from template file primitiveIterable.stg.
 */
public interface FloatIterable extends PrimitiveIterable
{
    FloatIterator floatIterator();

    float[] toArray();

    boolean contains(float value);

    boolean containsAll(float... source);

    boolean containsAll(FloatIterable source);

    void forEach(FloatProcedure procedure);

    /**
     * @since 7.0.
     */
    void each(FloatProcedure procedure);

    FloatIterable select(FloatPredicate predicate);

    FloatIterable reject(FloatPredicate predicate);

     RichIterable collect(FloatToObjectFunction function);

    float detectIfNone(FloatPredicate predicate, float ifNone);

    int count(FloatPredicate predicate);

    boolean anySatisfy(FloatPredicate predicate);

    boolean allSatisfy(FloatPredicate predicate);

    boolean noneSatisfy(FloatPredicate predicate);

    MutableFloatList toList();

    MutableFloatSet toSet();

    MutableFloatBag toBag();

    LazyFloatIterable asLazy();

     T injectInto(T injectedValue, ObjectFloatToObjectFunction function);


    double sum();

    float max();

    float maxIfEmpty(float defaultValue);

    float min();

    float minIfEmpty(float defaultValue);

    double average();

    double median();

    float[] toSortedArray();

    MutableFloatList toSortedList();
}