boofcv.misc.BoofLambdas Maven / Gradle / Ivy

/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * 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 boofcv.misc;

import java.util.List;

/**
 * Set of commonly used functions for Lambdas
 *
 * @author Peter Abeles
 */
public interface BoofLambdas {
	@FunctionalInterface interface MassageString {
		String process( String input );
	}

	@FunctionalInterface interface ToString {
		String process( T input );
	}

	@FunctionalInterface interface Factory {
		T newInstance();
	}

	@FunctionalInterface interface ProcessCall {
		void process();
	}

	@FunctionalInterface interface ProcessObject {
		void process( T object );
	}

	@FunctionalInterface interface Transform {
		T process( T object );
	}

	@FunctionalInterface interface Filter {
		/** Returns true if it should keep the object */
		boolean keep( T object );
	}

	@FunctionalInterface interface FilterInt {
		/** Returns true if it should keep the object */
		boolean keep( int value );
	}

	@FunctionalInterface interface FilterLong {
		/** Returns true if it should keep the object */
		boolean keep( long value );
	}

	@FunctionalInterface interface ProcessI {
		void process( int a );
	}

	@FunctionalInterface interface ProcessII {
		void process( int a, int b );
	}

	@FunctionalInterface interface ProcessIIB {
		boolean process( int a, int b );
	}

	@FunctionalInterface interface ProcessDD {
		void process( double a, double b );
	}

	@FunctionalInterface interface SelectElement {
		int select( List list );
	}

	@FunctionalInterface interface Extract {
		Out process( In o );
	}

	@FunctionalInterface interface ProcessIndex {
		void process( int index, T object );
	}

	@FunctionalInterface interface ProcessIndex2 {
		void process( int index, A objectA, B objectB );
	}

	@FunctionalInterface interface IndexToString {
		String process( int index );
	}

	@FunctionalInterface interface ConvertOut {
		Out process( In src );
	}

	@FunctionalInterface interface ConvertCopy {
		void process( In src, Out dst );
	}

	@FunctionalInterface interface PixXyzConsumer_F64 {
		void process( int pixX, int pixY, double x, double y, double z );
	}

	@FunctionalInterface interface PixXyzConsumer_F32 {
		void process( int pixX, int pixY, float x, float y, float z );
	}

	@FunctionalInterface interface IndexRgbConsumer {
		void setRgb( int index, int red, int green, int blue );
	}

	@FunctionalInterface interface Map_I32_I32 {
		int lookup( int src );
	}

	// @formatter:off
	@FunctionalInterface interface Match_I8 { boolean process( byte value ); }
	@FunctionalInterface interface Match_I16 { boolean process( short value ); }
	@FunctionalInterface interface Match_S32 { boolean process( int value ); }
	@FunctionalInterface interface Match_S64 { boolean process( long value ); }
	@FunctionalInterface interface Match_F32 { boolean process( float value ); }
	@FunctionalInterface interface Match_F64 { boolean process( double value ); }
	// @formatter:on
}