snumlautoken / dd2480-decide

DD2480-DECIDE

This is a module that is used in a anti-ballistic missile system used to decide whether to launch, or not launch a missile given certain inputs from its intruments.

Inputs are supplied via the Input class's static variables and then the decide method in the Decide class can be run to print a yes/no to the standard output representing launch/no launch.

Dependencies

• JDK 17
• Apache Maven 3.8.7

How to use

If you want to integrate package into your missile system you need to download and compile the code yourself. From there you can import the classes into your program and link when building your program. Make sure to set all relevant variables in the Input class before calling the decide method!

How to run tests

To run all tests, browse to the project folder and run mvn test in the command line.

Contributions

Arami

• The entirety of the decide class, including the decide function
• LICs 3,8 and 13
• Minimum enclosing radius function
• Connector enum in inputs
• Corresponding tests
• Created issues, reviewed pull requests, etc

Oskar

• Contributed in the code by writing the CMV class shell, LIC 2, 7 & 12 and tests for these functions.
• Wrote much of the documentation/comments for various classes and fields including the input and cmv class.
• Reviewed and merged pull requests etc.
• Also generally partook in creation of various issues, discussions and division of work.

Jakob

• Wrote LIC 0, 6, 10 & 11.
• Wrote tests for the same LICs.
• Issues, code reveiews and merges.
• Wrote much of the Essence documentation.

Felix

• Active in discussions about how we would start with the project
• Set up the project environment (folders/classes/maven)
• Wrote the base of the Input class
• Wrote the doubleCompare function and tests
• Wrote LIC 1 and 5 and tests for those
• Wrote a number of small issues that came up on the way
• Reviewed a number of pull requests and merged

Olivia

• Wrote LIC 4, 9 & 14
• Wrote tests and documentation for the same LICs
• Reviewed & merged pull requests

Essence: Way of Working

We assess that our current state is in the early stages of in use. More specifically at the checkpoint “The practices and tools are being used to do real work”. This is because we use the practices and tools, that we agreed upon, to solve the assignment. The previous two states are in regard to establishing principles, tools, and practices. Some of the checkpoints within these states are rather poorly suited for this assignment, for example, those in regard to stakeholders. Aside from that the team committed and agreed to the principles and constraints for the way of working, which we assess fulfilled the first state. For the second state, Foundation Established, the practices and tools were also selected and agreed upon (In the form of git, Java, Maven, Junit, discord). One checkpoint within this state that is probably not fulfilled is “All non-negotiable practices and tools have been identified”. This is not a task that was done and you could therefore argue that we didn’t get past this state. We do however feel that this is another checkpoint that is rather poorly suited for this assignment and assess that we reach the third state. The obstacles that are needed in order to reach the next state is to start to inspect and adapt our tools and practices, as this is something that we haven’t done. We would have to discuss and perform an evaluation to find what suits us and our work the best.

dd2480-decide's Issues

LIC 9 function

Implement LIC function 9 according to specification.

LIC 12 function

Implement LIC function 12 according to specification.

Initialize decide class

Create an empty decide class that will contain high level functionalities for the program.

LIC 6 function

Implement LIC function 6 according to specification.

Make exceptions more descriptive

LIC 4 function

Implement LIC function 4 according to specification.

Remove documentation from CMV class

Remove inconsistent documentation from CMV

Coordinates class

Create static class for coordinates inputs. Class should contain two arrays of same length, for x point data and y point data.

LIC 1 function

Implement LIC function 1 according to specification.

LIC 13 function

Implement LIC function 13 according to specification.

LIC 0 function

Implement LIC function 0 according to specification.

LIC 14 function

Implement LIC function 0 according to specification.

LIC 7 function

Implement LIC function 7 according to specification.

LIC 10 function

Implement LIC function 10 according to specification.

Function for minimum enclosing circle of three points

Gitignore binaries

Fix gitignore to ignore .class files and remove the target folder from the repo.

Initialize CMV functions (LICs) class

Create CMV class that contains basic definitions of the 15 LIC functions.

Add documentation to the Input class

Would be nice to have a JavaDoc comment for this class as well explaining in short what variables we have and their relation to the rest of the program.

Fix minRadiusEnclosure bug

Division by zero not handled.

Enum Comptype

Create and enum contained in CVM class used for comparison types: lesser than, equal and greater than (LT, EQ, GT)

Remaining test documentation

Add comments for the tests that have not yet been documented.

Add JavaDoc comments to the Decide class and function

We need a description for how the Decide class works and how to use the decide function

Input class

Global class containing static parameter class and coordinates array.

README overview

Description, dependencies, how to compile how to test.

LIC 8 function

Implement LIC function 8 according to specification.

All variables in the input class should be static

Variables in the input class should be static

Add documentation to CVM class

Add JavaDoc comment to CVM class and the calculate function. Add comments for the separate calculation methods.

LIC 2 function

Implement LIC function 2 according to specification.

Tests documentation

Short documentation describing tests. Everyone comments their own

Set up test class

Set up the test class and add simple tests to make sure input is working as intended.

Erroneous radius for minRadius when two points the same

Implement PUM, PUV and launch

Implement PUM, PUV and launch according to specification in decide()

Parameters class

Create a static class storing all parameters:
double LENGTH1;
double RADIUS1;
double EPSILON;
double AREA1;
int QPTS;
int QUADS;
double DIST;
int NPTS;
int KPTS;
int APTS
int BPTS
int CPTS;
int DPTS;
int EPTS
int EPTS
int FPTS
int GPTS
double LENGTH2;
double RADIUS2;
double AREA2;

Validate Input

Create method to make sure all input is valid that we can use before calculating the CMV.

LIC 3 function

Implement LIC function 3 according to specification.

README essence

Add some sentences about the essence checklist. Where we are at, what alphas we have fulfilled etc..

LIC 5 function

Implement LIC function 5 according to specification.

Basic java project structure

Create the basic java project structure with main and test subfolders

Enum Connectors

Create an enum storing values "NOTUSED", "OR", "ANDD" to be used for the logical connector matrix

Make PUV static

The PUV in the Input class is not static, needs to be fixed.

LIC 11 function

Implement LIC function 11 according to specification.

README statement of contribution

Everyone adds their own statement of contribution.

Double comparison function

Implement a function in CVM that compares doubles as according to spec. Returns a CompType enum value.