com.bakdata.dedupe.matching.WeightedEdge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation

Base interfaces and data structures for defining a deduplication workflow.

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2019 bakdata GmbH
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.bakdata.dedupe.matching;

import lombok.NonNull;
import lombok.Value;


/**
 * A weighted (directed) edge between two records.
 * The consumer may decide to treat the edge directed or undirected, please refer to the respective API
 * documentation.
 *
 * @param  the type of the records.
 */
@Value
public class WeightedEdge {
    /**
     * The first vertex.
     */
    @NonNull
    T first;
    /**
     * The second vertex.
     */
    @NonNull
    T second;
    /**
     * The weight. May be negative depending of the application.
     */
    double weight;

    /**
     * Reverses the direction of the edge by swapping the vertexes.
     * On applications with undirected edges, this operation is effectively no-op, although the instances will be
     * unequal.
     *
     * @return the edge with reversed direction.
     */
    public @NonNull WeightedEdge reversed() {
        return new WeightedEdge<>(this.second, this.first, this.weight);
    }
}