org.jheaps.annotations.LinearTime Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright 2014-2016, by Dimitrios Michail
 *
 * JHeaps Library
 * 
 * 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 org.jheaps.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marker interface to indicate that an operation takes O(n) time where n is the
 * size of the input. The primary purpose of this interface is to allow generic
 * algorithms to alter their behavior to provide good performance.
 * 
 * @author Dimitrios Michail
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LinearTime {

    /**
     * Whether the running time is amortized or actual.
     *
     * @return {@code true} if amortized, {@code false} if actual
     */
    boolean amortized() default false;

}