1 | /* |
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one |
---|
3 | * or more contributor license agreements. See the NOTICE file |
---|
4 | * distributed with this work for additional information |
---|
5 | * regarding copyright ownership. The ASF licenses this file |
---|
6 | * to you under the Apache License, Version 2.0 (the |
---|
7 | * "License"); you may not use this file except in compliance |
---|
8 | * with the License. You may obtain a copy of the License at |
---|
9 | * |
---|
10 | * http://www.apache.org/licenses/LICENSE-2.0 |
---|
11 | * |
---|
12 | * Unless required by applicable law or agreed to in writing, software |
---|
13 | * distributed under the License is distributed on an "AS IS" BASIS, |
---|
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
15 | * See the License for the specific language governing permissions and |
---|
16 | * limitations under the License. |
---|
17 | */ |
---|
18 | package org.apache.hadoop.util; |
---|
19 | |
---|
20 | /** |
---|
21 | * Interface for sort algorithms accepting {@link IndexedSortable} items. |
---|
22 | * |
---|
23 | * A sort algorithm implementing this interface may only |
---|
24 | * {@link IndexedSortable#compare} and {@link IndexedSortable#swap} items |
---|
25 | * for a range of indices to effect a sort across that range. |
---|
26 | */ |
---|
27 | public interface IndexedSorter { |
---|
28 | |
---|
29 | /** |
---|
30 | * Sort the items accessed through the given IndexedSortable over the given |
---|
31 | * range of logical indices. From the perspective of the sort algorithm, |
---|
32 | * each index between l (inclusive) and r (exclusive) is an addressable |
---|
33 | * entry. |
---|
34 | * @see IndexedSortable#compare |
---|
35 | * @see IndexedSortable#swap |
---|
36 | */ |
---|
37 | void sort(IndexedSortable s, int l, int r); |
---|
38 | |
---|
39 | /** |
---|
40 | * Same as {@link #sort(IndexedSortable,int,int)}, but indicate progress |
---|
41 | * periodically. |
---|
42 | * @see #sort(IndexedSortable,int,int) |
---|
43 | */ |
---|
44 | void sort(IndexedSortable s, int l, int r, Progressable rep); |
---|
45 | |
---|
46 | } |
---|