1/* 2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16package std.core; 17 18/** 19 * Can be implemented by any type that supports comparison. 20 */ 21export interface Comparable<T> { 22 23 /** 24 * Compares this instance to other object, treated as a `T` 25 * The result is less than 0 if this instance lesser than provided object 26 * 0 if they are equal 27 * and greater than 0 otherwise. 28 * 29 * @param other object to compare with 30 * 31 * @throws ClassCastError if other is not a `T` 32 * 33 * @returns result of the comparison 34 */ 35 compareTo(to: T): int; 36} 37