edge.go

// Copyright (c) 2024 Faculty of Industrial Technology and Management, KMUTNB (Provided by FITM Elite)
//
// 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 grafik

import "github.com/fitm-elite/grafik/options"

// Edge represents an edges in a graph. It contains start and end points.
type Edge[T comparable] struct {
	source *Vertex[T] // start point of the edges
	dest   *Vertex[T] // destination or end point of the edges

	properties options.EdgeProperties
}

func NewEdge[T comparable](source *Vertex[T], dest *Vertex[T], opts ...options.EdgeOptionFunc) *Edge[T] {
	e := &Edge[T]{
		source: source,
		dest:   dest,
	}
	for _, opt := range opts {
		opt(&e.properties)
	}

	return e
}

// Source returns edge source vertex
func (e Edge[T]) Source() *Vertex[T] {
	return e.source
}

// Destination returns edge dest vertex
func (e Edge[T]) Destination() *Vertex[T] {
	return e.dest
}

// Weight returns the weight of the edge.
func (e *Edge[T]) Weight() float64 {
	return e.properties.Weight()
}