Skip to content
This repository was archived by the owner on Sep 10, 2022. It is now read-only.

Added Identity Function for Math lib #37

Merged
merged 5 commits into from
May 24, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
41 changes: 41 additions & 0 deletions identity.hhs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/**
* @author Mudroad White
* @param input - a positive integer denoting the size of the expected matrix.
* @returns - a Mat object representing a 2D identity matrix.
*/

function identity(input) {

*import math: is_number

// Corner cases for input
// First, input should be a positive integer
if (!Number.isInteger(input) || input < 0) {
throw new Error('Expecped positive integer input')
}

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
if ( !(arguments.length === 1) ) {
throw new Error('Exception occurred in identity. Only 1 argument allowed, but a different number were entered.');
}

just a good safety check on the arguments so if the user uses the function incorrectly, they know which function they used incorrectly and why

// Then we return special Mat value when input is 0 or 1
if (input === 0) {
return new Mat([]);
}

if (input === 1) {
return new Mat([[1]]);
}

// Now we can start on creating the Id matrix
let result = new Mat().zeros(n, n);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
let result = new Mat().zeros(n, n);
let result = new Mat().zeros(input, input);

Copy link
Collaborator

Choose a reason for hiding this comment

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

n not defined, i assume you meant input for this and the one below (for loops n -> input)

for (let i = 0; i < n; i++){
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
for (let i = 0; i < n; i++){
for (let i = 0; i < input; i++){

result[i][i] = 1;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
result[i][i] = 1;
result.val[i][i] = 1;

because we're modifying a Mat instead of a JS array we can't access the indices directly, but rather have to access them through .val otherwise we get a 'cannot read 0' error

}

// return as a Mat object
return result;

// Note: the implementation of `result` above is for practicing purpose, from which I've learnt a lot.
// A better implementation suggested by the team is as follows, so feel free to alternate between the above
// version and the following one.
// result = mathjs.identity(input);
// // return the result as a mat object
// return mat(result);
}
26 changes: 26 additions & 0 deletions identity_test.hhs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/**
* @author Mudroad White
* @param
* @returns
*
* Functions for testing the identity function.
*/

function identity_test(){
*import math: identity

// Corner cases
if (!(identity(0) === new Mat([]))){
throw 'identity unit test failed on identity(0)';
}

if (!(identity(1) === new Mat([[1]]) )){
throw 'identity unit test failed on identity(1)';
}

// Ordinary case
const test1 = new Mat([[1, 0], [0, 1]]);
if (!(identity(2)) === test1){
throw 'identity unit test failed on identity(2)';
}
}