Skip to content
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.

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

Simple Matlab functions for post-simulation verification #6

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
function res = verifyCosineLawCriticalAngleStrategy(chip, n1, n2, n3)
import utils.squareIt;

aX = n1.x - n2.x;
aY = n1.y - n2.y;
bX = n3.x - n2.x;
bY = n3.y - n2.y;

aDotBSquared = squareIt((aX * bX) + (aY * bY));
aSquaredBSquared = (squareIt(aX) + squareIt(aY)) * (squareIt(bX) + squareIt(bY))

cosineSquaredTheta = aDotBSquared / aSquaredBSquared;
cosineSquaredThetaCritical = squareIt(cos(chip.criticalCrossingAngle));

res = cosineSquaredThetaCritical <= cosineSquaredTheta;
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
function res = verifyFiniteChipAreaRuleStrategy(chip, varargin)
res = 1;
for idx = 1:numel(varargin)
node = varargin{idx};
res = res & validateNodeCoordinates(chip, node);
end
end

function res = validateNodeCoordinates(chip, node)
res = node.x > 0.0 & ...
node.y > 0.0 & ...
node.x < chip.maximumChipSizeX & ...
node.y < chip.maximumChipSizeY;
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
function res = verifyMinimumChannelLength(chip, channel)
res = channel.len >= chip.minimumChannelLength;
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
function res = verifyPythagoreanLengthRuleStrategy(n1, n2, channel)
import utils.squareIt;

res = squareIt(n1.x - n2.x) + squareIt(n1.y - n2.y) == channel.len;
end
11 changes: 11 additions & 0 deletions src/main/matlab/+types/Channel.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
classdef Channel
properties
len
end

methods
function channel = Channel(len)
channel.len = len;
end
end
end
10 changes: 10 additions & 0 deletions src/main/matlab/+types/Chip.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
classdef Chip
properties
minimumNodeDistance
minimumChannelLength
maximumChipSizeX
maximumChipSizeY
criticalCrossingAngle
end

end
18 changes: 18 additions & 0 deletions src/main/matlab/+types/Node.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
classdef Node
properties
% x, y are assumed to be the co-ordinates of
% the top-left edge of the node
x
y
area
end

methods
function node = Node(x, y)
node.x = x;
node.y = y;
node.area = 0;
end
end

end
3 changes: 3 additions & 0 deletions src/main/matlab/+utils/squareIt.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
function res = squareIt(value)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code smell. Why is this almost trivial helper function necessary? What is the advantage over just writing (expr)^2 when I need to square something?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just readability. There's cases where writing (expr)^2 would lead end up looking like ((aX * bX) + (aY * bY)) ^ 2, where it isn't immediately clear where the power is being applied (to me at least). Having the function is easier to look at, and understand, what's happening IMO, but I'm happy to change it if there's strong opposition

res = value ^ 2;
end