Added comments to Dine.java

visheshdembla · web-flow · commit bb6dd07bc955 · 2017-10-28T20:53:28.000+05:30
diff --git a/Dine.java b/Dine.java
@@ -1,3 +1,4 @@
+/* Program for the classic dining philosopher problem in operating system */
 package javacodes;
 
 
@@ -8,14 +9,15 @@ public static void main(String[] args){
 		int x=10;
 
 		Log.msg(String.valueOf(x));
- 
+ 		/* Initializing 5 chopsticks */
 		Chopstick[] chopistics = new Chopstick[5];
 
 		for(int i=0; i< chopistics.length; i++){
                     
 			chopistics[i] = new Chopstick("C: "+i);
 		}
                 
+		// Initialising five philosophers and their corresponding positions 
 		Philosopher[] philosophers = new Philosopher[5];
                 
 		philosophers[0] = new Philosopher("P: 0 - ", chopistics[0], chopistics[1]);
@@ -39,7 +41,7 @@ public static void main(String[] args){
  	}
 }
 
-
+//Class for philosophers
 class Philosopher extends Thread
 {
 	private Chopstick leftChopistick;
@@ -63,6 +65,9 @@ public Philosopher ( String name, Chopstick left, Chopstick right){
  
 	public void eat()
 	{
+	// While eating, every philosopher pics up the left chopstick first and the the right chopstick. If the philosopher gets both the chopsticks
+	// he eats for 1000 ms and then releases the chopsticks
+	//Else he waits for chopsticks to be free
 		if(! leftChopistick.used){
                     
 			if(!rightChopistick.used){
@@ -116,6 +121,7 @@ public static void Delay(int ms){
 	}
 }
 
+//Class for chopstick that provides use and release functionalities to pilosophers
 class Chopstick{
 
 	public boolean used;
@@ -126,13 +132,15 @@ public Chopstick(String name){
             
 		this.name = name;
 	}
-
+	//method to reserve the chopstick for use
 	public synchronized void take() {
             
 		Log.msg ("Used :: " + name );
                 
 		this.used = true;
 	}
+	
+	//method to release the chopstick for use
 	public synchronized void release() {
             
 		Log.msg ("Released :: " + name );

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+/* Program for the classic dining philosopher problem in operating system */`
`1`	`2`	`package javacodes;`
`2`	`3`
`3`	`4`
`@@ -8,14 +9,15 @@ public static void main(String[] args){`
`8`	`9`	`int x=10;`
`9`	`10`
`10`	`11`	`Log.msg(String.valueOf(x));`
`11`		`-`
	`12`	`+ /* Initializing 5 chopsticks */`
`12`	`13`	`Chopstick[] chopistics = new Chopstick[5];`
`13`	`14`
`14`	`15`	`for(int i=0; i< chopistics.length; i++){`
`15`	`16`
`16`	`17`	`chopistics[i] = new Chopstick("C: "+i);`
`17`	`18`	`}`
`18`	`19`
	`20`	`+ // Initialising five philosophers and their corresponding positions`
`19`	`21`	`Philosopher[] philosophers = new Philosopher[5];`
`20`	`22`
`21`	`23`	`philosophers[0] = new Philosopher("P: 0 - ", chopistics[0], chopistics[1]);`
`@@ -39,7 +41,7 @@ public static void main(String[] args){`
`39`	`41`	`}`
`40`	`42`	`}`
`41`	`43`
`42`		`-`
	`44`	`+//Class for philosophers`
`43`	`45`	`class Philosopher extends Thread`
`44`	`46`	`{`
`45`	`47`	`private Chopstick leftChopistick;`
`@@ -63,6 +65,9 @@ public Philosopher ( String name, Chopstick left, Chopstick right){`
`63`	`65`
`64`	`66`	`public void eat()`
`65`	`67`	`{`
	`68`	`+ // While eating, every philosopher pics up the left chopstick first and the the right chopstick. If the philosopher gets both the chopsticks`
	`69`	`+ // he eats for 1000 ms and then releases the chopsticks`
	`70`	`+ //Else he waits for chopsticks to be free`
`66`	`71`	`if(! leftChopistick.used){`
`67`	`72`
`68`	`73`	`if(!rightChopistick.used){`
`@@ -116,6 +121,7 @@ public static void Delay(int ms){`
`116`	`121`	`}`
`117`	`122`	`}`
`118`	`123`
	`124`	`+//Class for chopstick that provides use and release functionalities to pilosophers`
`119`	`125`	`class Chopstick{`
`120`	`126`
`121`	`127`	`public boolean used;`
`@@ -126,13 +132,15 @@ public Chopstick(String name){`
`126`	`132`
`127`	`133`	`this.name = name;`
`128`	`134`	`}`
`129`		`-`
	`135`	`+ //method to reserve the chopstick for use`
`130`	`136`	`public synchronized void take() {`
`131`	`137`
`132`	`138`	`Log.msg ("Used :: " + name );`
`133`	`139`
`134`	`140`	`this.used = true;`
`135`	`141`	`}`
	`142`	`+`
	`143`	`+ //method to release the chopstick for use`
`136`	`144`	`public synchronized void release() {`
`137`	`145`
`138`	`146`	`Log.msg ("Released :: " + name );`