/**
 * Copyright 2016 Twitter. All rights reserved.
 *
 * 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.twitter.graphjet.bipartite.api;

/**
 * This interface should specify all the optimize operations that are needed from a bipartite
 * graph. The function takes an {@link OptimizableBipartiteGraphSegment}, creates a compacted
 * version of its edge indexes, and replaces its old edge indexes with the new compacted version.
 */
public interface OptimizableBipartiteGraph {
  /**
   * Replace the edge indexes of the input segment to a new compacted version.
   *
   * @param segment the segment to be optimized
   */
  void optimize(OptimizableBipartiteGraphSegment segment);
}
