Skip to content

Relax undirected edge constructor validation #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Relax undirected edge constructor validation #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions src/QuikGraph/Structures/Edges/UndirectedEdge.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,28 @@ public class UndirectedEdge<TVertex> : IUndirectedEdge<TVertex>
/// <param name="target">The target vertex.</param>
/// <exception cref="T:System.ArgumentNullException"><paramref name="source"/> is <see langword="null"/>.</exception>
/// <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
/// <exception cref="T:System.ArgumentException">
/// <paramref name="target"/> is not lower than <paramref name="source"/> when using <see cref="M:System.Collections.Generic.Comparer{T}.Default"/>.
/// </exception>
public UndirectedEdge([NotNull] TVertex source, [NotNull] TVertex target)
{
if (source == null)
throw new ArgumentNullException(nameof(source));
if (target == null)
throw new ArgumentNullException(nameof(target));

TVertex orderedSource;
TVertex orderedTarget;
if (Comparer<TVertex>.Default.Compare(source, target) > 0)
throw new ArgumentException($"{nameof(source)} must be lower than {nameof(target)} in {GetType().Name}.");
{
orderedSource = target;
orderedTarget = source;
}
else
{
orderedSource = source;
orderedTarget = target;
}

Source = source;
Target = target;
Source = orderedSource;
Target = orderedTarget;
}

/// <inheritdoc />
Expand Down
21 changes: 13 additions & 8 deletions tests/QuikGraph.Tests/Structures/Edges/EquatableUndirectedEdgeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,33 @@ public void Construction()
var v2 = new ComparableTestVertex("v2");
CheckEdge(new EquatableUndirectedEdge<ComparableTestVertex>(v1, v2), v1, v2);
CheckEdge(new EquatableUndirectedEdge<ComparableTestVertex>(v1, v1), v1, v1);

// Order correctly on creation
CheckEdge(new EquatableUndirectedEdge<int>(2, 1), 1, 2);

// Comparable
var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
CheckEdge(new EquatableUndirectedEdge<ComparableTestVertex>(comparableV2, comparableV1), comparableV1,
comparableV2);
}

[Test]
public void Construction_Throws()
{
// ReSharper disable ObjectCreationAsStatement
// ReSharper disable AssignNullToNotNullAttribute
Assert.Throws<ArgumentNullException>(() => new EquatableUndirectedEdge<TestVertex>(null, new TestVertex("v1")));
Assert.Throws<ArgumentNullException>(() => new EquatableUndirectedEdge<TestVertex>(new TestVertex("v1"), null));
Assert.Throws<ArgumentNullException>(() =>
new EquatableUndirectedEdge<TestVertex>(null, new TestVertex("v1")));
Assert.Throws<ArgumentNullException>(() =>
new EquatableUndirectedEdge<TestVertex>(new TestVertex("v1"), null));
Assert.Throws<ArgumentNullException>(() => new EquatableUndirectedEdge<TestVertex>(null, null));
// ReSharper restore AssignNullToNotNullAttribute

Assert.Throws<ArgumentException>(() => new EquatableUndirectedEdge<int>(2, 1));

// Not comparable
var v1 = new TestVertex("v1");
var v2 = new TestVertex("v2");
Assert.Throws<ArgumentException>(() => new EquatableUndirectedEdge<TestVertex>(v1, v2));

var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
Assert.Throws<ArgumentException>(() => new EquatableUndirectedEdge<ComparableTestVertex>(comparableV2, comparableV1));
// ReSharper restore ObjectCreationAsStatement
}

Expand Down
24 changes: 16 additions & 8 deletions tests/QuikGraph.Tests/Structures/Edges/TaggedUndirectedEdgeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,36 @@ public void Construction()
CheckTaggedEdge(new TaggedUndirectedEdge<ComparableTestVertex, TestObject>(v1, v2, null), v1, v2, (TestObject)null);
CheckTaggedEdge(new TaggedUndirectedEdge<ComparableTestVertex, TestObject>(v1, v1, null), v1, v1, (TestObject)null);
CheckTaggedEdge(new TaggedUndirectedEdge<ComparableTestVertex, TestObject>(v1, v2, tag), v1, v2, tag);

// Order correctly on creation
CheckTaggedEdge(new TaggedUndirectedEdge<int, TestObject>(2, 1, null), 1, 2, (TestObject)null);

// Comparable
var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
CheckTaggedEdge(
new TaggedUndirectedEdge<ComparableTestVertex, TestObject>(comparableV2, comparableV1, null),
comparableV1, comparableV2, (TestObject)null);
}

[Test]
public void Construction_Throws()
{
// ReSharper disable ObjectCreationAsStatement
// ReSharper disable AssignNullToNotNullAttribute
Assert.Throws<ArgumentNullException>(() => new TaggedUndirectedEdge<TestVertex, TestObject>(null, new TestVertex("v1"), null));
Assert.Throws<ArgumentNullException>(() => new TaggedUndirectedEdge<TestVertex, TestObject>(new TestVertex("v1"), null, null));
Assert.Throws<ArgumentNullException>(() => new TaggedUndirectedEdge<TestVertex, TestObject>(null, null, null));
Assert.Throws<ArgumentNullException>(() =>
new TaggedUndirectedEdge<TestVertex, TestObject>(null, new TestVertex("v1"), null));
Assert.Throws<ArgumentNullException>(() =>
new TaggedUndirectedEdge<TestVertex, TestObject>(new TestVertex("v1"), null, null));
Assert.Throws<ArgumentNullException>(() =>
new TaggedUndirectedEdge<TestVertex, TestObject>(null, null, null));
// ReSharper restore AssignNullToNotNullAttribute

Assert.Throws<ArgumentException>(() => new TaggedUndirectedEdge<int, TestObject>(2, 1, null));

// Not comparable
var v1 = new TestVertex("v1");
var v2 = new TestVertex("v2");
Assert.Throws<ArgumentException>(() => new TaggedUndirectedEdge<TestVertex, TestObject>(v1, v2, null));

var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
Assert.Throws<ArgumentException>(() => new TaggedUndirectedEdge<ComparableTestVertex, TestObject>(comparableV2, comparableV1, null));
// ReSharper restore ObjectCreationAsStatement
}

Expand Down
13 changes: 8 additions & 5 deletions tests/QuikGraph.Tests/Structures/Edges/UndirectedEdgeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ public void Construction()
var v2 = new ComparableTestVertex("v2");
CheckEdge(new UndirectedEdge<ComparableTestVertex>(v1, v2), v1, v2);
CheckEdge(new UndirectedEdge<ComparableTestVertex>(v1, v1), v1, v1);

// Order correctly on creation
CheckEdge(new UndirectedEdge<int>(2, 1), 1, 2);

// Comparable
var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
CheckEdge(new UndirectedEdge<ComparableTestVertex>(comparableV2, comparableV1), comparableV1, comparableV2);
}

[Test]
Expand All @@ -33,16 +41,11 @@ public void Construction_Throws()
Assert.Throws<ArgumentNullException>(() => new UndirectedEdge<TestVertex>(null, null));
// ReSharper restore AssignNullToNotNullAttribute

Assert.Throws<ArgumentException>(() => new UndirectedEdge<int>(2, 1));

// Not comparable
var v1 = new TestVertex("v1");
var v2 = new TestVertex("v2");
Assert.Throws<ArgumentException>(() => new UndirectedEdge<TestVertex>(v1, v2));

var comparableV1 = new ComparableTestVertex("v1");
var comparableV2 = new ComparableTestVertex("v2");
Assert.Throws<ArgumentException>(() => new UndirectedEdge<ComparableTestVertex>(comparableV2, comparableV1));
// ReSharper restore ObjectCreationAsStatement
}

Expand Down