001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.math.graph;
031
032import java.util.Comparator;
033
034/**
035 * A simple weighted edge representation
036 * 
037 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
038 *
039 * @param <VERTEX>
040 */
041public class SimpleWeightedEdge<VERTEX> extends SimpleEdge<VERTEX> {
042        /**
043         * {@link Comparator} for sorting edges in ascending order
044         */
045        public final static Comparator<SimpleWeightedEdge<?>> ASCENDING_COMPARATOR = new Comparator<SimpleWeightedEdge<?>>() {
046                @Override
047                public int compare(SimpleWeightedEdge<?> o1, SimpleWeightedEdge<?> o2) {
048                        if (o1.weight == o2.weight) return 0;
049                        return o1.weight < o2.weight ? -1 : 1;
050                }
051        };
052        
053        /**
054         * {@link Comparator} for sorting edges in descending order
055         */
056        public final static Comparator<SimpleWeightedEdge<?>> DESCENDING_COMPARATOR = new Comparator<SimpleWeightedEdge<?>>() {
057                @Override
058                public int compare(SimpleWeightedEdge<?> o1, SimpleWeightedEdge<?> o2) {
059                        if (o1.weight == o2.weight) return 0;
060                        return o1.weight < o2.weight ? 1 : -1;
061                }
062        };
063        
064        /**
065         * The edge weight
066         */
067        public float weight;
068}