Programming Fundamentals

Objectives

  • using arrays
  • using struct arrays
  • creating functions
  • using while loops for repetition

Reminder: Help sessions

Help sessions are running this week!

These are one of the best ways for you to get one on one help with a tutor for any course content (including Lab Exercises and Assignments).

For the dates and times of the help sessions, see the Help Session Timetable.

To join a help session, or for more information, see the COMP(1511|1911) Help Session Microsoft Teams.

For face-to-face help sessions, the lab map can be found here. If help sessions are running in other buildings you can use Lost on Campus to help you find them.

Activities To Be Completed

The following is a list of all the activities available to complete this week...

Worth 1 mark(s) in total:

  • devowel
  • print_pi_style
  • scanning_into_array_style
  • points

Worth 1 mark(s) in total:

  • savings_analysis
  • cs_calculator

Worth 0.5 mark(s) in total:

  • detective

Problem sets are capped at 15 marks (there are 4 possible bonus marks from the three-dot exercises that can bring you up to a total of 15 if you missed out on any other marks in the one- or two-dot exercises).

Completing just the one and two-dot exercises every week can give you the full 15 marks needed in this component.

For more details, see the course outline.

Preparation

Before the lab you should re-read the relevant lecture slides and their accompanying examples.

When attempting the following exercises, make sure to read the whole exercise, including any hints and assumptions that may make the exercise easier.

Exercise
(●◌◌)
:

Devowelling Text

Write a C program devowel.c which reads characters from its input and writes the same characters to its output, except it does not write lower case vowels ('a', 'e', 'i', 'o', 'u').

Your program should stop only at the end of input.

Examples

dcc devowel.c -o devowel
./devowel
Are you saying 'Boo' or 'Boo-Urns'?
Ar y syng 'B' r 'B-Urns'?
In this house, we obey the laws of thermodynamics!
In ths hs, w by th lws f thrmdynmcs!

You can run an automated code style checker using the following command:
1511 style devowel.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest devowel

When you are finished working on this exercise, you and your lab partner must both submit your work by running give:

give cs1511 lab04_devowel devowel.c

Note, even though this is a pair exercise, you both must run give from your own account before Tuesday 08 October 20:00 to obtain the marks for this lab exercise.

Sample solution for devowel.c
//  Written 3/3/2018 by Andrew Taylor (andrewt@unsw.edu.au)
//  read characters from stdin and write to stdout
//  except lower case vowels ('a', 'e','i', 'o', 'u') are not written

#include <stdio.h>

int is_vowel(char character);

int main(void) {

    char character;
    while (scanf("%c", &character) == 1) {

        if (!is_vowel(character)) {
            printf("%c", character);
        }
    }

    return 0;
}

// return 1 if character is a lower case vowel
// 0 otherwise
int is_vowel(char character) {
    return character == 'a' ||
           character == 'e' ||
           character == 'i' ||
           character == 'o' ||
           character == 'u';
}

Exercise
(●◌◌)
:

Print out pi to a certain number of digits

Good code style is required for this exercise.

To get full marks in this exercise, you MUST pass the automatic style checker (1511 style).

If 1511 style finds any issues in your code, the maximum mark you can achieve for this exercise is capped at 75%.

To run the automatic style checker on your code, use the following command:

1511 style print_pi_style.c

Download print_pi_style.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity print_pi_style

Your task is to add code to these functions in print_pi_style.c:

void print_pi_style(int num_digits) {
    // DO NOT CHANGE THIS LINE
    int pi[MAX_DIGITS] = {3, 1, 4, 1, 5, 9, 2, 6, 5, 3};
    // TODO: Finish this function below

}

Write a C program, print_pi_style.c, which prints out the first n digits of pi, where n is specified by the user.

The main function has already been written for you. There's an empty function that has been provided for you called print_pi_style that takes in one integer as an argument.

Place your code (only the printing code) inside this function. You can NOT put all of your code in main for this exercise, main must remain unmodified.

Examples

dcc print_pi_style.c -o print_pi_style
./print_pi_style
How many digits of pi would you like to print? 3
3.14
./print_pi_style
How many digits of pi would you like to print? 5
3.1415
./print_pi_style
How many digits of pi would you like to print? 10
3.141592653

Assumptions/Restrictions/Clarifications

  • You can assume that n >= 2 AND n <= 10, however, do not use this as a reason to avoid while loops.
You can run an automated code style checker using the following command:
1511 style print_pi_style.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest print_pi_style

When you are finished working on this exercise, you must submit your work by running give:

give cs1511 lab04_print_pi_style print_pi_style.c

You must run give before Tuesday 08 October 20:00 to obtain the marks for this lab exercise. Note that this is an individual exercise, the work you submit with give must be entirely your own.

Sample solution for print_pi_style.c
//Prints the first n digits of pi, where n is specified
// by the user
// Liz Willer
// (fake zID: z5255555)
// 2020-03-07

#include <stdio.h>

#define MAX_DIGITS 10

void print_pi_style(int num_digits);

int main(void) {
    printf("How many digits of pi would you like to print? ");
    // TODO: Insert your code here to read in digits
    int digits;
    scanf("%d", &digits);
    // TODO: Call the print_pi_style function you finished
    print_pi_style(digits);

    return 0;
}

void print_pi_style(int num_digits) {
    // DO NOT CHANGE THIS LINE
    int pi[MAX_DIGITS] = {3, 1, 4, 1, 5, 9, 2, 6, 5, 3};
    // TODO: Finish this function below
    int i = 0;
    while (i < num_digits) {
        if (i == 1) {
            printf(".");
        }
        printf("%d", pi[i]);
        i++;
    }
    printf("\n");
}

Exercise
(●◌◌)
:

Scanning numbers into an array

Good code style is required for this exercise.

To get full marks in this exercise, you MUST pass the automatic style checker (1511 style).

If 1511 style finds any issues in your code, the maximum mark you can achieve for this exercise is capped at 75%.

To run the automatic style checker on your code, use the following command:

1511 style scanning_into_array_style.c

Download scanning_into_array_style.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity scanning_into_array_style

Write a C program scanning_into_array_style.c which scans in a certain amount of numbers from the user and fills an array with them.

  • First, it scans in the quantity of numbers from the user.
  • Then, it scans in that many numbers from the user.

Once the array is filled with the numbers the user input, call a pre-written function that prints the minimum and maximum values in that array

Examples

dcc scanning_into_array_style.c -o scanning_into_array_style
./scanning_into_array_style
How many numbers: 5
Please enter numbers: 1
2
3
4
5
Minimum: 1
Maximum: 5
./scanning_into_array_style
How many numbers: 4
Please enter numbers: 3
-2
7
1
Minimum: -2
Maximum: 7

Assumptions/Restrictions/Clarifications

  • The given inputs will always be integers.
  • The given list of numbers will never be more than 100 numbers.
You can run an automated code style checker using the following command:
1511 style scanning_into_array_style.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest scanning_into_array_style

When you are finished working on this exercise, you must submit your work by running give:

give cs1511 lab04_scanning_into_array_style scanning_into_array_style.c

You must run give before Tuesday 08 October 20:00 to obtain the marks for this lab exercise. Note that this is an individual exercise, the work you submit with give must be entirely your own.

Sample solution for scanning_into_array_style.c
// 
// Written 5th March 2022
// By William Setiawan
// (fake zID: z5255555)
// Program which scans a certain number of integers into an array, then prints
// the minimum and maximum values in the array.
//

#include <stdio.h>

#define MAX_SIZE 100

// Given an integer array, iterate over the array and print the minimum and
// maximum values in the array.
void print_array_minmax(int length, int arr[MAX_SIZE]);

int main(void) {
    int scanned_length;
    int length_count = 0;
    int scanned_value;
    int scanned_num[MAX_SIZE];

    // Prompts user for the specific number of integers to be taken from input
    printf("How many numbers: ");
    scanf("%d", &scanned_length);

    // Only takes in scanned_length number of integers
    printf("Please enter numbers: ");
    while (length_count < scanned_length) {
        scanf("%d", &scanned_value);
        scanned_num[length_count] = scanned_value;

        length_count++;
    }
    
    // Print the minimum and maximum values
    print_array_minmax(scanned_length, scanned_num);

    return 0;
}

//////////////////////// DO NOT CHANGE THE CODE BELOW! ////////////////////////

// Given an integer array, iterate over the array and print the minimum and
// maximum values in the array.
//
// Takes in:
// - `length` -- The length of the array.
// - `arr[MAX_SIZE]` -- The integer array to iterate over.
//
// Returns: nothing.
void print_array_minmax(int length, int arr[MAX_SIZE]) {
    int index = 0;
    if (length > 0) {
        int minimum = arr[index];
        int maximum = arr[index];

        while (index < length) {
            if (arr[index] < minimum) {
                minimum = arr[index];
            } else if (arr[index] > maximum) {
                maximum = arr[index];
            }
            
            index++;
        }

        printf("Minimum: %d\nMaximum: %d\n", minimum, maximum);
    }
    
    return;
}

Exercise
(●◌◌)
:

Using struct arrays to store points of a shape

Download points.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity points

Complete the C program points.c, so that it scans in all the points of a shape into an array of structs. It should then print out the points that were given.

First, it scans in the number of points that the shape has. Then, it scans in the coordinates of each point. Afterwards, it prints out the points in order.

Examples

dcc points.c -o points
./points
How many points in the shape? 2
Enter points:
1.231 4.560
7.892 0.12

Shape Points:
 1: x = 1.231, y = 4.560
 2: x = 7.892, y = 0.120
./points
How many points in the shape? 4
Enter points:
6.340 2.781
5.675 2.453
4.893 0.123
0.232 3.349

Shape Points:
 1: x = 6.340, y = 2.781
 2: x = 5.675, y = 2.453
 3: x = 4.893, y = 0.123
 4: x = 0.232, y = 3.349

Assumptions/Restrictions/Clarifications

  • When asked for the number of points, you will be given a non-zero positive integer.
  • All inputs will be the correct type and non-zero positive numbers.
  • The number of points will not exceed 10.
You can run an automated code style checker using the following command:
1511 style points.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest points

When you are finished working on this exercise, you must submit your work by running give:

give cs1511 lab04_points points.c

You must run give before Tuesday 08 October 20:00 to obtain the marks for this lab exercise. Note that this is an individual exercise, the work you submit with give must be entirely your own.

Sample solution for points.c
// points.c SOLUTION
// Written 17 June 2023
// By Gab Steiner
//
// This is a c program that scans in points belonging to a shape in a random
// order, then prints them out in the correct order.

#include <stdio.h>

#define MAX_POINTS 10

struct point {
    double x_coord;
    double y_coord;
};


// Prints a point out.
void print_point(int point_no, double x, double y);

int main(void) {

    // Declare an array of points of size MAX_POINTS
    struct point shape[MAX_POINTS];

    printf("How many points in the shape? ");
    // scan in number of points in the shape
    int no_points;
    scanf("%d", &no_points);

    printf("Enter points:\n");
    // scan in the details of each point into the array
    int index = 0;
    while (index < no_points) {
        
        scanf("%lf", &shape[index].x_coord);        // scan the x_coord
        scanf("%lf", &shape[index].y_coord);        // scan the y_coord
        
        index = index + 1;
    }

    printf("\nShape Points:\n");
    // print all the points

    // Go through all the points and print them
    for (int count = 0; count < no_points; count++) {
        print_point(count + 1, shape[count].x_coord, shape[count].y_coord);
    }

    return 0;
}


//  Prints a single point in the correct format.
//
// Parameters:
// - `point_no` -- The point number
// - `x`        -- The x-coordinate of the point
// - `y`        -- The y-coordinate of the point
//
// Returns: nothing.
void print_point(int point_no, double x, double y) {
    
    printf("%2d: x = %.3lf, y = %.3lf\n", point_no, x, y);
}

Exercise
(●●◌)
:

Savings Analysis

Download savings_analysis.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity savings_analysis

You have been provided with some starter code savings_analysis.c with functions for you to complete: calc_yearly_deposits, calc_yearly_spending, calc_ending_balance and calc_months_saving_goal_met. It is your job to implement the functions and complete the program.

The program reads in the user's starting balance and monthly saving goal for the year. This is followed by 12 months of deposits and 12 months of spending. The program then runs a series of functions to analyse the account over the year. It is your job to complete these functions.

Examples

dcc savings_analysis.c -o savings_analysis
./savings_analysis
Please enter starting balance: 1320 
Please enter monthly saving goal: 60      
Please enter monthly deposits: 208 234 182 182 208 156 156 182 208 208 234 260
Please enter monthly spending: 120 103 150 122 130 372 106 115 127 124 104 200

Yearly deposits = $2418
Yearly spending = $1773
Ending balance  = $1965
You met the monthly saving goal 9 times!
./savings_analysis
Please enter starting balance: 500
Please enter monthly saving goal: 220
Please enter monthly deposits: 800 850 900 870 820 880 890 830 910 850 860 840
Please enter monthly spending: 600 620 610 630 640 615 610 625 600 630 635 670

Yearly deposits = $10300
Yearly spending = $7485
Ending balance  = $3315
You met the monthly saving goal 8 times!

Assumptions/Restrictions/Clarifications

  • The function names in your solution should be the same as the provided starter code.
  • Numbers entered will always be positive integers.
  • The correct amount of input will always be provided. That is, the number of monthly deposits and monthly spending will always be 12.
  • You must implement the functions specified to pass the autotests and receive marks for this activity.
You can run an automated code style checker using the following command:
1511 style savings_analysis.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest savings_analysis

When you are finished working on this exercise, you must submit your work by running give:

give cs1511 lab04_savings_analysis savings_analysis.c

You must run give before Tuesday 08 October 20:00 to obtain the marks for this lab exercise. Note that this is an individual exercise, the work you submit with give must be entirely your own.

Sample solution for savings_analysis.c
// Savings Analysis
// savings_analysis.c
//
// This program was written by Morgan Swaak (z5476300)
// on 03/02/24
//
// A program to do analysis on a savings account.

#include <stdio.h>

#define NUM_MONTHS 12

struct transaction {
    int deposits;
    int spending;
};

int calc_yearly_deposits(struct transaction transactions[NUM_MONTHS]);
int calc_yearly_spending(struct transaction transactions[NUM_MONTHS]);
int calc_ending_balance(int starting_balance, struct transaction transactions[NUM_MONTHS]);
int calc_months_saving_goal_met(int saving_goal, struct transaction transactions[NUM_MONTHS]);

// main funciton initalises transactions array and prints results
int main(void) {
    // array initalisation
    int starting_balance;
    int saving_goal;
    struct transaction transactions[NUM_MONTHS]; 
    printf("Please enter starting balance: ");
    scanf("%d", &starting_balance);
    printf("Please enter monthly saving goal: ");
    scanf("%d", &saving_goal);
    printf("Please enter monthly deposits: ");
    int i = 0;
    while (i < NUM_MONTHS) {
        scanf("%d", &transactions[i].deposits);
        i++;
    }
    printf("Please enter monthly spending: ");
    i = 0;
    while (i < NUM_MONTHS) {
        scanf("%d", &transactions[i].spending);
        i++;
    }

    // print out analysis
    int yearly_deposits = calc_yearly_deposits(transactions);
    int yearly_spending = calc_yearly_spending(transactions);
    int ending_balance = calc_ending_balance(starting_balance, transactions);
    int num_months = calc_months_saving_goal_met(saving_goal, transactions);

    printf("\n");
    printf("Yearly deposits = $%d\n", yearly_deposits);
    printf("Yearly spending = $%d\n", yearly_spending);
    printf("Ending balance  = $%d\n", ending_balance);
    printf("You met the monthly saving goal %d times!\n", num_months);
    return 0;
}

// calculates and returns the total amount of money deposited
int calc_yearly_deposits(struct transaction transactions[NUM_MONTHS]) {
    int yearly_deposits = 0;
    int i = 0;
    while (i < NUM_MONTHS) {
        yearly_deposits += transactions[i].deposits;
        i++;
    }
    return yearly_deposits;
}

// calculates and returns the total amount of money spent
int calc_yearly_spending(struct transaction transactions[NUM_MONTHS]) {
    int yearly_spending = 0;
    int i = 0;
    while (i < NUM_MONTHS) {
        yearly_spending += transactions[i].spending;
        i++;
    }
    return yearly_spending;
}

// calculates and returns the ending balance of an account
int calc_ending_balance(
    int starting_balance, 
    struct transaction transactions[NUM_MONTHS]
) {
    return starting_balance + calc_yearly_deposits(transactions) - calc_yearly_spending(transactions);
}

// returns the the number of months the saving goal was met
int calc_months_saving_goal_met(
    int saving_goal, 
    struct transaction transactions[NUM_MONTHS]
) {
    int num_months = 0;
    int i = 0;
    while (i < NUM_MONTHS) {
        if (transactions[i].deposits - transactions[i].spending >= saving_goal) {
            num_months += 1;
        }
        i++;
    }
    return num_months;
}

Exercise
(●●◌)
:

Create a simple calculator, reading different numbers of integers

For this exercise, make a program called cs_calculator.c which will scan in instructions until End-Of-Input (which we enter to our terminal with the keyboard shortcut CTRL-D) and prints the output as specified below. An instruction is a character, followed by one or two positive integers.

The first character identifies what type the instruction is.

  • If the first character in the instruction is 's', then your program should print out the square of the next number in the instruction.
  • If the first character in the instruction is 'p', then your program should print out the value of the next number raised to the power of the number after next.

Examples

dcc cs_calculator.c -o cs_calculator
./cs_calculator
Enter instruction: s 2
4
Enter instruction: p 5 3
125
Enter instruction: s 4
16
Enter instruction: p 3 4
81
Enter instruction: 
./cs_calculator
Enter instruction: p 3 3
27
Enter instruction: s 10
100
Enter instruction: 

One major challenge of this exercise is figuring out how to use scanf effectively. The lessons you learn in this exercise regarding scanf will be useful in assignment 1!

Assumptions/Restrictions/Clarifications

  • You can assume that the first character in the instruction is only either 's' or 'p'
  • You can assume that for each instruction, the correct number of successive positive integers will be given.
  • The autotest for this exercise expects your program to end WITHOUT a new line character when the user presses Ctrl-D. This means that the command prompt for the next command should be on the same line as the end of your program.
You can run an automated code style checker using the following command:
1511 style cs_calculator.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest cs_calculator

When you are finished working on this exercise, you and your lab partner must both submit your work by running give:

give cs1511 lab04_cs_calculator cs_calculator.c

Note, even though this is a pair exercise, you both must run give from your own account before Tuesday 08 October 20:00 to obtain the marks for this lab exercise.

Sample solution for cs_calculator.c
// Author: Dean Wunder
// d.wunder@unsw.edu.au
// 2020-05-04
// A arbitrary calculator app designed to help students
// understand variable length input scanning before assignment 1.

#include <stdio.h>

#define SQUARE_COMMAND 's'
#define POWER_COMMAND  'p'

int main (void) {

    char command;
    printf("Enter instruction: ");
    while (scanf(" %c", &command) == 1) {
        if (command == SQUARE_COMMAND) {
            int num;
            scanf("%d", &num);
            printf("%d\n", num * num);
        } else if (command == POWER_COMMAND) {
            int base, power;
            scanf("%d %d", &base, &power);
            int i = 0;
            int result = 1;
            while (i < power) {
                result *= base;
                i++;
            }
            printf("%d\n", result);
        }
        printf("Enter instruction: ");
    }

    return 0;
}

Exercise
(●●●)
:

Detective

Download detective.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity detective

Your mission (if you choose to accept it) is to complete the program detective.c to decipher encoded messages.

Over the past few months UNSW Security Society has found seemingly normal messages paired with random numbers. To help you solve this challenge we have created the program detective.c that reads in the message and numbers, storing them in a struct array.

We have been lucky enough to find one decoded message:

Encoded Message: muahahaha_we're_so_evil#_GNTY

Secret Numbers: 7-23-3-6-13-22-24-2-16-4-14-18-20-11-9-28-21-1-27-8-0-26-12-5-10-15-25-19-17

Deciphered Message: haha_we_are_TeasiNG_You

Our observations from this are:

  • Messages seem to end with a #.
  • There are always the same number of letters as there are numbers.
  • Letters maintain their case between their encoded and deciphered message.
  • Each number is unique counting from 0 to n - 1 (where n is the number of letters).

We wish you luck detective!

Examples

dcc detective.c -o detective
./detective
Please enter Encrypted Message: muahahaha_we're_so_evil#_GNTY
Please enter Secret Numbers: 7-23-3-6-13-22-24-2-16-4-14-18-20-11-9-28-21-1-27-8-0-26-12-5-10-15-25-19-17
Secret Message is: haha_we_are_TeasiNG_You
./detective
Please enter Encrypted Message: STUDENTS_L0VE_COMP1511_#new_students_aww_:)
Please enter Secret Numbers: 28-12-24-38-6-33-36-27-16-7-19-17-39-2-11-14-32-31-41-23-18-15-0-21-35-9-40-20-1-30-5-42-4-25-13-26-37-34-22-8-29-10-3
Secret Message is: sTEw_MeET_at_Unsw_tuNneLS_11:05

Assumptions/Restrictions/Clarifications

  • The maximum number of characters is 100.
  • The number of characters in the encrypted message and the amount of secret numbers are the same.
  • The case of each letter is preserved in translation.
  • Messages will end with a #.
You can run an automated code style checker using the following command:
1511 style detective.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest detective

When you are finished working on this exercise, you must submit your work by running give:

give cs1511 lab04_detective detective.c

You must run give before Tuesday 08 October 20:00 to obtain the marks for this lab exercise. Note that this is an individual exercise, the work you submit with give must be entirely your own.

Sample solution for detective.c
// Detective
// detective.c
//
// This program was written by Morgan Swaak (z5476300)
// on 02/02/24
//
// A program to decipher hidden messages in enemy codes.

#include <stdio.h>

#define MAX_SIZE 100

struct code {
    char letter;
    int number;
};

int main(void) {
    //////////////// DO NOT CHANGE ANY OF THE CODE BELOW HERE //////////////////
    struct code message[MAX_SIZE];

    // read in message
    printf("Please enter Encrypted Message: ");
    int i = 0;
    char letter;
    scanf("%c", &letter);
    while(letter != '\n') {
        message[i].letter = letter;
        scanf("%c", &letter);
        i++;
    }

    // read in numbers
    printf("Please enter Secret Numbers: ");
    int j = 0;
    int number;
    scanf("%d", &number);
    message[j].number = number;
    j++;
    while (j != i) {
        scanf("-%d", &number);
        message[j].number = number;
        j++;
    }
    //////////////// DO NOT CHANGE ANY OF THE CODE ABOVE HERE //////////////////

    ////////////////////////////////////////////////////////////////////////////
    ///////////////////// ONLY WRITE CODE BELOW HERE ///////////////////////////
    ////////////////////////////////////////////////////////////////////////////

    printf("Secret Message is: ");

    int index = message[0].number;
    while (message[index].letter != '#') {
        printf("%c", message[index].letter);
        index = message[index].number;
    }
    printf("\n");

    ////////////////////////////////////////////////////////////////////////////
    ///////////////////// ONLY WRITE CODE ABOVE HERE ///////////////////////////
    ////////////////////////////////////////////////////////////////////////////
    return 0;
}

Exercise — individual:
(Not for Marks) Refactoring - Class Details

Download class_details.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity class_details

For this activity, you've been provided with a fully working program: class_details.c.

While this code produces the correct output, it's code style is not very good.

In particular, class_detail.c is full of magic numbers and repeating code, and it's main function is more than 200 lines long!

Try running 1511 style class_details.c to see even more of it's style issues.

For this activity your job is to go through and improve the readability of the code by

  • Replacing magic numbers with enums and #defines,
  • Breaking it up into small functions (less than 40 lines),
  • Using those functions to remove unnecessary repetition,
  • Writing some function comments to document the code.

You shouldn't change any of the actual functionality of the program i.e. none of the changes you make should change any of the program's output.

Program description

Below is a description of the program. Keep in mind that this has all already been implemented for you.

The provided program scans in and stores the details of students in a class. It first scans in the size of the class, and then scans in the details of each of the students including:

  • zID
  • Degree type (Undergraduate/Postgraduate)
  • Major (if an Undergraduate)
  • Assignments mark (Collated mark of assignments and labs)
  • Exam mark
  • Course grade

Once all student details have been scanned in, the program then loops and scans in commands. It doesn't stop looping until the QUIT command is entered. The program performs one of the following tasks:

  • Command 0 Help: Display program instructions
  • Command 1 (Display Student): Print the details of a specific student
  • Command 2 (Display Class): Print the details of all students in a class
  • Command 3 (Quit): Exit the program

Examples

dcc class_details.c -o class_details
./class_details
Enter Class Size: 1
Student 1: 
Enter zID: 5111111
Select Degree Type: 
0: Undergraduate
1: Postgraduate
0
Select Major: 
0: Computer Science
1: Database Systems
2: eCommerce Systems
3: Artificial Intelligence
4: Programming Languages
5: Computer Networks
6: Embedded Systems
7: Security Engineering
8: None
2
Enter Assignments mark (out of 60): 35.5
Enter exam mark (out of 40): 30
Enter Command Number (0 for Help): 0
Enter a number corresponding to one of the following commands: 
0 (Help): Display program instructions
1 (Display Student): Print the details of a specific student
2 (Display Class): Print the details of all students in a class
3 (Quit): Exit the program
Enter Command Number (0 for Help): 1
Enter Student zID: 5222222 
No student with that zID exists
Enter Command Number (0 for Help): 1
Enter Student zID: 5111111 
z5111111: {
        Degree Type: Undergraduate
        Major: eCommerce Systems
        Assignments Mark: 35.50/60
        Exam Mark: 30.00/40
        Course Grade: 65.50/100
}
Enter Command Number (0 for Help): 100
Invalid Command
Enter Command Number (0 for Help): 3
Exiting Program
./class_details
Enter Class Size: 2
Student 1: 
Enter zID: 5111111
Select Degree Type: 
0: Undergraduate
1: Postgraduate
0
Select Major: 
0: Computer Science
1: Database Systems
2: eCommerce Systems
3: Artificial Intelligence
4: Programming Languages
5: Computer Networks
6: Embedded Systems
7: Security Engineering
8: None
6
Enter Assignments mark (out of 60): 35.5
Enter exam mark (out of 40): 30
Student 2: 
Enter zID: 5222222
Select Degree Type: 
0: Undergraduate
1: Postgraduate
1
Enter Assignments mark (out of 60): 40.5
Enter exam mark (out of 40): 25.9
Enter Command Number (0 for Help): 2
Students: 
z5111111: {
        Degree Type: Undergraduate
        Major: Embedded Systems
        Assignments Mark: 35.50/60
        Exam Mark: 30.00/40
        Course Grade: 65.50/100
}
z5222222: {
        Degree Type: Postgraduate
        Assignments Mark: 40.50/60
        Exam Mark: 25.90/40
        Course Grade: 66.40/100
}
Enter Command Number (0 for Help): 1
Enter Student zID: 5222222
z5222222: {
        Degree Type: Postgraduate
        Assignments Mark: 40.50/60
        Exam Mark: 25.90/40
        Course Grade: 66.40/100
}
Enter Command Number (0 for Help): 3
Exiting Program

Assumptions/Restrictions/Hints

  • You should not change the functionality of the program in any way
  • If there are any edge cases not handled by the original code (e.g. students sharing zids), you do not need to modify the code to handle them
  • All inputs will positive, and be the correct type
You can run an automated code style checker using the following command:
1511 style class_details.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest class_details
Sample solution for class_details.c
// Written June 2022
// By Enzo Lee Solano (z5258621)
//
// Interactive program to scan in and display the details of students in a 
// class.

#include <stdio.h>

#define MAX_CLASS_SIZE 20
#define MAX_EXAM_MARK 40
#define MAX_ASSIGMENTS_MARK 60
#define NOT_FOUND -1

enum loop_sentinal { STOP_LOOPING, KEEP_LOOPING };
enum command {HELP, PRINT_STUDENT, PRINT_CLASS, QUIT, INVALID_COMMAND };
enum degree_type {UGRD, PGRD, INVALID_DEGREE};
enum major {
    COMPA1,
    COMPD1,
    COMPE1,
    COMPI1,
    COMPJ1,
    COMPN1,
    COMPS1,
    COMPY1,
    NONE
};

struct student {
    int z_id;
    enum major major;
    enum degree_type degree_type;
    double assignments_mark;
    double exam_mark;
    double course_grade;
};

//Additional Helper Functions:
void print_degree_prompt(void);
void print_major_prompt(void);
double clamp_double(double n, double lower, double higher);
void print_class(int class_size, struct student class[MAX_CLASS_SIZE]);
int find_student_index(int z_id, int class_size, 
                       struct student class[MAX_CLASS_SIZE]);
void print_help_prompt(void);
void find_and_print_student(int class_size, 
                            struct student class[MAX_CLASS_SIZE]);


// Required Functions:
void print_degree_type(enum degree_type degree_type);
enum degree_type scan_degree(void);
void print_major(enum major major);
enum major scan_major(void);
struct student scan_student_details(void);
void print_student(struct student student);
enum command scan_command(void);


int main(void) {
    int class_size;
    printf("Enter Class Size: ");
    scanf("%d", &class_size);

    if (class_size <= 0 || class_size > MAX_CLASS_SIZE) {
        printf("Class Size must be between 1 and %d\n", MAX_CLASS_SIZE);
        // Exit the program early
        return 0;
    }

    struct student class[MAX_CLASS_SIZE];

    int i = 0;
    while (i < class_size) {
        printf("Student %d: \n", i + 1);
        class[i] = scan_student_details();
        i++;
    }

    enum loop_sentinal is_looping = KEEP_LOOPING;
    while (is_looping) {
        printf("Enter Command Number (0 for Help): ");

        enum command command = scan_command();
        if (command == HELP) {
            print_help_prompt();
        } else if (command == PRINT_STUDENT) {
            find_and_print_student(class_size, class);
        } else if (command == PRINT_CLASS) {
            print_class(class_size, class);
        } else if (command == QUIT) {
            is_looping = STOP_LOOPING;
        } else {
            printf("Invalid Command\n");
        }
    }

    printf("Exiting Program\n");

    return 0;
}


// Given a `enum degree_type`, prints out the corresponding string.
void print_degree_type(enum degree_type degree_type) {
    if (degree_type == UGRD) {
        printf("Undergraduate\n");
    } else if (degree_type == PGRD) {
        printf("Postgraduate\n");
    } else {
        printf("INVALID\n");
    }
}

// Prints the prompt which explains to the user how to input a degree_type.
void print_degree_prompt(void) {
    printf("Select Degree Type: \n");
    enum degree_type degree_type = UGRD;
    while (degree_type <= PGRD) {
        printf("%d: ", degree_type);
        print_degree_type(degree_type);
        degree_type++;
    }
}

// Scans in a degree as an integer and maps it to the corresponding 
// `enum degree_type`
// returns : INVALID_DEGREE, if the scanned integer does not correspond to a
//           degree type,
//         : else, the corresponding degree_type
enum degree_type scan_degree(void) {

    int scanned_degree_type;
    scanf("%d", &scanned_degree_type);
    enum degree_type degree_type = INVALID_DEGREE;
    if (scanned_degree_type == UGRD || scanned_degree_type == PGRD) {
        degree_type = scanned_degree_type;
    }

    return degree_type;
}



// Given a `enum major`, prints out the corresponding string.
void print_major(enum major major) {
    if (major == COMPA1) {
        printf("Computer Science\n");
    } else if (major == COMPD1) {
        printf("Database Systems\n");
    } else if (major == COMPE1) {
        printf("eCommerce Systems\n");
    } else if (major == COMPI1) {
        printf("Artificial Intelligence\n");
    } else if (major == COMPJ1) {
        printf("Programming Languages\n");
    } else if (major == COMPN1) {
        printf("Computer Networks\n");
    } else if (major == COMPS1) {
        printf("Embedded Systems\n");
    } else if (major == COMPY1) {
        printf("Security Engineering\n");
    } else {
        printf("None\n");
    }
}

// Prints the prompt which explains to the user how to input a major.
void print_major_prompt(void) {
    printf("Select Major: \n");
    enum major major = COMPA1;
    while (major <= NONE) {
        printf("%d: ", major);
        print_major(major);
        major++;
    }
}

// Scans in a COMP/SCI major as an integer and maps it to the corresponding 
// `enum major`
// returns : NONE, if the scanned integer does not correspond to a
//           MAJOR,
//         : else, the corresponding major
enum major scan_major(void) {
    int scanned_major;
    scanf("%d", &scanned_major);
    enum major major = NONE;
    if (scanned_major >= COMPA1 && scanned_major < NONE) {
        major = scanned_major;
    }

    return major;
}

// Clamps n in the range lower <= n <= higher
// Parameters
//      n     : the number to clamp
//      lower : the lower bound
//      higher: the upper bound
//
// returns : the clamped value.
double clamp_double(double n, double lower, double higher) {
    double clamped_n = n;
    if (n > higher) {
        clamped_n = higher;
    } else if (n < lower) {
        clamped_n = lower;
    }

    return clamped_n;
}

// Scans in all the details for a single student, and returns the details as a
// `struct student`.
//
// returns : the new struct student.
struct student scan_student_details(void) {
    struct student new_student;
    printf("Enter zID: ");
    scanf("%d", &new_student.z_id);

    print_degree_prompt();
    new_student.degree_type = scan_degree();

    new_student.major = NONE;
    if (new_student.degree_type == UGRD) {
        print_major_prompt();
        new_student.major = scan_major();
    }

    printf("Enter Assignments mark (out of %d): ", MAX_ASSIGMENTS_MARK);
    double assignments_mark;
    scanf("%lf", &assignments_mark);
    assignments_mark = clamp_double(assignments_mark, 0, MAX_ASSIGMENTS_MARK);

    printf("Enter exam mark (out of %d): ", MAX_EXAM_MARK);
    double exam_mark;
    scanf("%lf", &exam_mark);
    exam_mark = clamp_double(exam_mark, 0, MAX_EXAM_MARK);

    new_student.assignments_mark = assignments_mark;
    new_student.exam_mark = exam_mark;
    new_student.course_grade = exam_mark + assignments_mark;

    return new_student;
}

// Given a `struct student`, prints out the formatted details of the student.
void print_student(struct student student) {
    printf("z%07d: {\n", student.z_id);
    printf("\tDegree Type: ");
    print_degree_type(student.degree_type);

    if (student.degree_type == UGRD) {
        printf("\tMajor: ");
        print_major(student.major);
    }

    printf("\tAssignments Mark: %3.02lf/%d\n", student.assignments_mark, 
           MAX_ASSIGMENTS_MARK);
    printf("\tExam Mark: %3.02lf/%d\n", student.exam_mark, MAX_EXAM_MARK);
    printf("\tCourse Grade: %3.02lf/%d\n", student.course_grade, 
           MAX_ASSIGMENTS_MARK + MAX_EXAM_MARK);
    printf("}\n");
}

// Given an array of `struct student`s, prints out the formatted details 
// all students in the array.
void print_class(int class_size, struct student class[MAX_CLASS_SIZE]) {
    printf("Students: \n");
    int i = 0;
    while (i < class_size) {
        print_student(class[i]);
        i++;
    }
}

// Given a specific zID, finds and returns the index of the corresponding 
// student.
// Parameters
//      z_id       : the zID of the student to find
//      class_size : the number of students in the class
//      class      : an array of students
//
// returns : NOT_FOUND, if `z_id` does not correspond to a student in the array.
//         : the index of the first occurance of a student with zID: `z_id`,
//           otherwise.
int find_student_index(int z_id, int class_size, 
                       struct student class[MAX_CLASS_SIZE]) {
    int i = 0;
    int student_index = NOT_FOUND;
    while (i < class_size) {
        if (class[i].z_id == z_id) {
            student_index = i;
        }
        i++;
    }

    return student_index;
}


// Prints the prompt which explains to the user how to input different commands
void print_help_prompt(void) {
    printf("Enter a number corresponding to one of the following commands: \n");
    printf("0 (Help): Display program instructions\n");
    printf("1 (Display Student): Print the details of a specific student\n");
    printf("2 (Display Class): Print the details of all students in a class\n");
    printf("3 (Quit): Exit the program\n");
}


// Scans in a command as an integer and maps it to the corresponding 
// `enum command`
// returns : INVALID_COMMAND, if the scanned integer does not correspond to a
//           command,
//         : else, the corresponding command
enum command scan_command(void) {

    int scanned_command;
    scanf("%d", &scanned_command);
    enum command command = INVALID_COMMAND;
    if (scanned_command >= HELP && scanned_command <= QUIT) {
        command = scanned_command;
    }

    return command;
}

// Scans in a zID and displays the details of the corresponding student in a 
// given class.
//
// Parameters
//      class_size : the number of students in the class
//      class      : an array of students
void find_and_print_student(int class_size, struct student class[MAX_CLASS_SIZE]) {
    printf("Enter Student zID: ");
    int z_id;
    scanf("%d", &z_id);
    int student_index = find_student_index(z_id, class_size, class);

    if (student_index == NOT_FOUND) {
        printf("No student with that zID exists\n");
    } else {
        print_student(class[student_index]);
    }
}

Exercise — individual:
(Not For Marks) Debugging - Letter Search

Download debug_letter_search.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity debug_letter_search

Note that this exercise is not marked or worth marks!

Debugging Tips!

Some debugging tips for you:

  • dcc output - as you run into issues, dcc will point you to where the errors are. Remember that dcc gives you the line number the issue is on, and will give some sort of explanation. Make sure you read everything dcc gives you. Sometimes we get “errors carried forward”, so find your first error, fix that, then recompile.
  • print statements - sometimes it can be handy to see if the flow of your code puts you in the spot you expect it to be (ie. inside the right if statement, or going through a loop the correct amount of times). A quick way you can check this is by putting print statements in your code for testing purposes, like "the value of x is %d and y is %d". This lets you check that you got against what you expected.
  • COMP1511 debugging guide

The Task

This exercise reads in a letter from the user, and then searches more input given by the user for that letter, or until CTRL+D is entered. It then tells the user if the search was sucessful or not.

Examples

dcc debug_letter_search.c -o debug_letter_search
./debug_letter_search
Which letter are we searching for?: g
COMP1511 is awesome!
hmmm, how about this?
what about now?
hm. How about frog?
We found g!!!
./debug_letter_search
Which letter are we searching for?: ?
No questions here.
Only sentences.
I could have a question.
Nah

The mission was not successful :(

Walkthrough

Below is a video walkthrough of this exercise! Make sure to attempt it before watching this video

You can run an automated code style checker using the following command:
1511 style debug_letter_search.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest debug_letter_search
Sample solution for debug_letter_search.c
// debug_letter_search.c SOLUTION
//
// Write a C program that takes in a letter from the user, and then searches 
// more input given by the user for that letter, or until CTRL+D is entered.
//
// Gab Steiner, June 2023

#include <stdio.h>

#define TRUE 1
#define FALSE 0

int main(void) {
    // Get the letter we are trying to find
    printf("Which letter are we searching for?: ");
    char target;
    scanf("%c", &target);

    // Loop through input until we get the target, or ctrl+d
    char letter;
    int found = FALSE;
    while (found == FALSE && scanf("%c", &letter) == 1) {
        // Check if we found the letter
        if (letter == target) {
            found = TRUE;
        }
    }

    // Tell the user if we found it or not
    if (found == TRUE) {
        printf("We found %c!!!\n", target);
    } else {
        printf("The mission was not successful :(\n");
    }

    return 0;
}

Exercise — individual:
(Not For Marks) Debugging - Clouds

Download debug_cloud.c here

Or, copy these file(s) to your CSE account using the following command:

1511 fetch-activity debug_cloud

Note that this exercise is not marked or worth marks!

Debugging Tips!

Some debugging tips for you:

  • dcc output - as you run into issues, dcc will point you to where the errors are. Remember that dcc gives you the line number the issue is on, and will give some sort of explanation. Make sure you read everything dcc gives you. Sometimes we get “errors carried forward”, so find your first error, fix that, then recompile.
  • print statements - sometimes it can be handy to see if the flow of your code puts you in the spot you expect it to be (ie. inside the right if statement, or going through a loop the correct amount of times). A quick way you can check this is by putting print statements in your code for testing purposes, like "the value of x is %d and y is %d". This lets you check that you got against what you expected.
  • COMP1511 debugging guide

The Task

This exercise reads in some cloud heights from a user and works out what type of clouds they are. The program then prints out the total count for all the types.

Note that fog clouds are the lowest, then cumulo, then alto, then cirro clouds occur at the highest heights.

Examples

dcc debug_cloud.c -o debug_cloud
./debug_cloud
Enter some clouds:
200
550
880
2500
100000

CLOUDS
There are 1 fog clouds
There are 2 cumulo clouds
There are 1 alto clouds
There are 1 cirro clouds
./debug_cloud
Enter some clouds:
65000
80000
3000
4000
4690.23
12.54
24.57
8

CLOUDS
There are 3 fog clouds
There are 0 cumulo clouds
There are 3 alto clouds
There are 2 cirro clouds

Walkthrough

Below is a video walkthrough of this exercise! Make sure to attempt it before watching this video

You can run an automated code style checker using the following command:
1511 style debug_cloud.c

When you think your program is working, you can use autotest to run some simple automated tests:

1511 autotest debug_cloud
Sample solution for debug_cloud.c
// debug_cloud.c SOLUTION
// This is a C program that reads in some clouds and tallies the types.
// Gab Steiner, June 2023

#include <stdio.h>

enum levels {
    LOW = 500,
    MID = 2000,
    HIGH = 6000
};

enum cloud_type {
    FOG,
    CUMULO,
    ALTO,
    CIRRO
};

struct cloud {
    double height;
    enum cloud_type type;
};

int cloud_type_count(enum cloud_type type, struct cloud clouds[10], 
                            int count);

int main(void) {
    struct cloud sky[10];    

    printf("Enter some clouds:\n");
    // Scan in some clouds
    int index = 0;
    while (scanf("%lf", &sky[index].height) == 1) {

        // Determine the type of cloud based on it's height
        if (sky[index].height > HIGH) {
            sky[index].type = CIRRO;
        } else if (sky[index].height > MID) {
            sky[index].type = ALTO;
        } else if (sky[index].height > LOW) {
            sky[index].type = CUMULO;
        } else {
            sky[index].type = FOG;
        }

        index++;
    }

    // Print out the total for each cloud
    printf("\nCLOUDS\n");
    printf("There are %d fog clouds\n", cloud_type_count(FOG, sky, index));
    printf("There are %d cumulo clouds\n", cloud_type_count(CUMULO, sky, index));
    printf("There are %d alto clouds\n", cloud_type_count(ALTO, sky, index));
    printf("There are %d cirro clouds\n", cloud_type_count(CIRRO, sky, index));

    return 0;
}

// This function counts the number of times a specific type of cloud was seen.
//
// ARGS:
// - type is the type of cloud being looked for.
// - clouds is an array of cloud structs.
// - count is the number of clouds filled in the array.
//
// RETURN:
// - total is the number of clouds of the specific type that were found.
//
int cloud_type_count(enum cloud_type type, struct cloud clouds[10], 
                            int count) {
    
    int total = 0;

    // Find all the clouds with that type
    for (int i = 0; i < count; i++) {
        if (clouds[i].type == type) {
            total++;
        }
    }

    return total;
}

Submission

When you are finished each exercises make sure you submit your work by running give.

You can run give multiple times. Only your last submission will be marked.

Don't submit any exercises you haven't attempted.

If you are working at home, you may find it more convenient to upload your work via give's web interface.

Remember you have until Week 5 Tuesday 20:00 to submit your work.

You cannot obtain marks by e-mailing your code to tutors or lecturers.

You check the files you have submitted here.

Automarking will be run by the lecturer several days after the submission deadline, using test cases different to those autotest runs for you. (Hint: do your own testing as well as running autotest.)

After automarking is run by the lecturer you can view your results here. The resulting mark will also be available via give's web interface.