Kodutöö II

Kodutöö üldnõudedKodutöö ülesande variantNäidislahendus

Kodutöö 2 raames tuleb sul luua tarkvaraline lahendus vastavalt variandis antud teemale ja nõuetele. Loodud lahendus tuleb dokumenteerida.

Sellel ülesandel on kaks põhilist fookust. Esiteks funktsioonide loomine, kasutamine ja dokumenteerimine. Teiseks põhjalikum veaohtlike olukordade tuvastamine, analüüs ning võimalusel lahenduste leidmine ning nende dokumenteerimine.

Testimiseks tuleb kasutada voo suunamist.

NB! Videosse jäänud lehekülg ei pruugi kajastada kõige viimast versiooni ülesannete nõuetest! Veendu, et kõik nõuded on täidetud vastavalt praeguse ülesandelehe versioonile.

Aruande mall

Aruande malliks kasuta Kodutöö 1 raames välja toodud malle (https://blue.pri.ee/ttu/programmeerimine-i/kodutoo-i/) ning kohanda see ise sobivaks antud kodutööle.

Aruande sisu

Tiitelleht
Autorideklaratsioon
Lühendite ja mõistete sõnastik (vajadusel)
Sisukord
Jooniste ja tabelite loetelu (vajadusel)
Ülesande püstitus ja variant
Loodud lahenduse kirjeldus pikkusega 2 – 4 A4 lehekülge. Kirjeldus peab olema arusaadavalt struktureeritud. Kasuta selleks tabeleid, jooniseid, loendeid, alampealkirju jt struktuurseid elemente. Kirjeldus ei tohi olla üks suur müür teksti!
- Mis on su programmi eesmärk – st mida teeb?
- Programmi lähteandmete kirjeldus (kust lähteandmed tulevad, mis formaadis need olema peavad, mis järjekorras sisendeid oodatakse ning mis piirangud sisenditele on).
- Programmi töövoog (mis järjekorras mida tehakse, lühidalt ja üldistatult).
- Eriolukordade analüüs ja nende lahendamine
  - Analüüsi olukordi (nt sisendeid), mis tekitavad vigu või probleeme sinu programmis.
  - Selgita kuidas iga olukorra lahendasid ning põhjenda miks otsustasid just selle lahenduse kasuks (võid näiteks võrrelda alternatiiviga).
  - NB! Siin peavad olema kirjeldatud ka olukorrad, mida pole autor suutnud olemasolevate teadmiste põhjal lahendada oma programmis, kuid on teadlik nende olemasolust.
Kokkuvõte
- Kirjuta mõni lause oma tööprotsessi kohta.
- Kirjuta mõni lause ülesandest ja selle keerukusest.
- Kui võimalik, hinda ülesande ajalist mahtu.
- Täiendavad kommentaarid, emotsioonid, mõtted.
Kasutatud kirjandus (vajadusel)
- Kõik mis ei olnud kaetud selle õppeaine raames ja mida sa ei loonud iseseisvalt.
- Ka näiteks sõbra või kursusekaaslase abi tuleks viidata: https://libraryguides.vu.edu.au/ieeereferencing/personalcommunication
- Kui kasutasid tehisintellekti (nt ChatGPT), peab ka selle kasutus olema viidatud.
- Viited allikatele peavad olema täpsed. Näiteks viitena stackoverflow.com või google.com ei sobi. Viide peab olema konkreetsele leheküljele kust informatsioon pärineb.
Lisa: Ekraanitõmmis(ed) töötavast programmist
- Ekraanitõmmisel peab olema näidatud kuidas kasutad programmi kasutades voo suunamist! Jäta käsk vähemalt ühel pildil nähtavaks.
- Ekraanitõmmised peaksid illustreerima erinevaid situatsioone millega sinu programm toime tuleb
- Ekraanitõmmised võivad olla pandud lisana, kuid võivad olla ka põimitud lahenduse kirjelduse sisse. Sellisel juhul võid kirjelduse lehekülje jagu pikema teha.

Nõuded sisendile

Loodavat rakendust võidakse kasutada kahte moodi.

Kasutades programmi läbi voo suunamise. See tekitab nõuded sisendi järjestusele programmis, lähemalt kirjeldatud “sisendfaili struktuur” osas.
Kasutades programmi tavapäraselt, st käivitades selle ja trükkides klaviatuurilt sisendit. See tekitab vajaduse kasutajale selgete käskluste ja tagasiside andmiseks.

Maksimaalselt peab sinu programm töötama 15 sisendiga. St 1-dimensioonilise massiivi puhul võib olla suuruseks maksimaalselt 15 liiget, 2-dimensioonilise massiivi puhul 15 x 15.

Koos oma ülesande variandiga saad ka 2 tekstifaili näidissidenditega. Sinu programm peab lugema sisendit samas järjekorras nagu etteantud sisendfailides. Need 2 faili on ka sinu esimesteks testfailideks.

Osa sinu ülesandest on analüüsida ja lahendada situatsioone, millega su programm võib silmitsi seista. Näiteks pead läbi mõtlema mida teha olukorras kui kasutaja soovib sulle anda vaid 1 sisendi? või hoopis 100?

Lisaks peab loodav programm peab suutma toime tulla ebasobiva sisendiga sama andmetüübi piires! Näiteks oodates positiivset täisarvu sisestab kasutaja hoopis negatiivse täisarvu.

Küll aga ei testi me sinu programmi olukordades, kus sisendid antakse vales järjekorras või mõnes teises andmetüübis. Näiteks kui ootad sisendiks täisarvu, siis saad garanteeritult täisarvu (me ei proovi sisendis anda sulle täisarvu asemel näiteks tähemärke).

Sisendfaili struktuur

Sisendfailis on esimene number alati sellele järgneva massiivi liikmete arv. Kui tegu on maatriksitega, siis selle suuruse määravad esimesed 2 numbrit.

Näiteks ülesandes kus tuleb leida tudengite keskmine hinne võiks olla sisendfail järgnev: 9 1 0 4 5 5 3 5 4 2

Esimene number 9 ütleb mitu hinnet on, millele järgnevad 9 hinnet.

Nõuded koodimisstandardile ja keskkonnale

Loodav programm peab olema kirjutad C programmeerimiskeeles. Kasutada tohib C90 ja C99 koodistandardeid. Kokkuleppel tohib kasutada ka uuemaid standardeid (nt C11, C17).

Lisaks C standardteekidele tohid kasutada ka C POSIX ja GNU C teeke. Teiste teekide kasutamine väljaspool eelnimetatut ainult kokkuleppel!

Loodav programm peab töötama Linux keskkonnas. Eelistatud on operatsioonisüsteemist sõltumatu lahendus. Kood kompileeritakse ja testitakse laboris oleva Linux seadistusega võrdväärses keskkonnas (nt OpenSUSE SLED-15 SP5 või Ubuntu Linux 24.04 koos GCC-13 kompilaatoriga).

Nõuded koodile

Kood peab lähtuma seni õpitud praktikatest.
Programm peab lugema oma sisendi stdin standardvoost. Me testime sinu programmi nii sisendvoo suunamisega kui otse käsurealt käivitades ja trükkides sisendit klaviatuurilt.
Koodis puuduvad kasutamata komponendid (nt teegifailid, muutujad).
Koodis on realiseeritud vähemalt minimaalselt nõutud funktsioonid. Enamikes variantides on mõistlik neid rohkem teha.
Kui koodis tekib kordusi, siis tuleb selle asemel luua funktsioon ning seda korduvalt kasutada.
Andmevahetus toimub funktsioonidega ainult edastavate parameetrite ja tagastuse kaudu. Globaalmuutujate kasutamine pole lubatud!
Funktsioonide prototüübid asuvad faili päises, funktsioonide sisu pärast main() funktsiooni. Eraldi päisefaili kasutamine on soovi korral lubatud (tulevikuteema).
Täidetud on kõik koodimisstiilis etteantud nõuded, muuhulgas:
- Kõik funktsioonid on kommenteeritud kasutades standartset kommentaari kuju (kirjeldus, parameetrid, tagastus).
- Kõik funktsioonid, muutujad ja preprotsessori makrod on arusaadavalt nimetatud ja korrektselt vormistatud.
- Faili päises on kommentaar mis kirjeldab programmi, autorit jne

Lisaülesanne boonuspunktide teenimiseks

Kodutöö eest on võimalik saada kuni 2 boonuspunkti. Lisaülesannete osalise lahendamise eest on samuti võimalik punkte saada, kuniks see on dokumenteeritud nõuetekohaselt.

Boonuspunktide saamiseks tuleb lisaks ülesande baasnõuetele täita järgmised nõuded

Rakendus peab toetama järgnevaid käsureaargumente
- -i=file_name ja --input=file_name – Programm loeb sisendi etteantud failist ning kuvab kohe vastuse ekraanile
- -p=interactive ja --prompt=interactive – Programm loeb sisendi stdin standardvoost. Programm peab selgelt väljendama mida kasutaja sisestama peab ning kuvama veateateid. Tegu on vaikeolekuga.
- -p=disabled ja --prompt=disabled – Programm loeb sisendi stdin standardvoost. Programm ei tohi esitada kasutajale ühtegi küsimust sisendite kohta. Ekraanil kuvatakse vaid tulemused.
- --help – Kuvab juhised programmi kasutamiseks kasutades klassikalist abilehe struktuuri ja stiili (vt näited nt grep --help või man grep )
Programm ei tohi katki minna kui numbri asemel antakse talle kogemata näiteks tekst.
Aruandesse tuleb lisada täiendav esimese astme nummerdatud pealkiri “Lisaülesanded”.
- Kirjelda lisaülesande raames lisatud funktsionaalsus.
- Kirjuta kuidas lähenesid käsureargumentide lisamisele ja kontrollile.
- Kirjuta kuidas otsustasid, mis on oluline kuvada abilehel.
- Selgita oma lähenemist sisendi kontrollile, et rakendus valet tüüpi sisendi korral katki ei läheks.

Tähtajad

Terviklik kodutöö tuleb esitada hiljemalt 15.12.2024 23:59:59 (kohalik aeg)

Kodutöö tähtaja ületamisel vähendatakse lõpptulemust 1 punkti võrra igal hilinetud nädala kohta. Maksimaalselt vähendatakse tulemust 5 punkti võrra, st esitades töö 7 nädalat hiljem kaotad ikkagi 5 punkti töö tulemusest.

Kui kodutöö kohta tekib täiendavaid küsimusi või esineb kahtlusi autorluses, hinnatakse kodutöö tulemusega 0 punkt. Sellisel juhul tuleb punktide saamiseks kodutöö kaitsta.

Vajadusel rakendatakse [Vääritu käitumise menetlemise korda].

Viimane päev kodutöö esitamiseks ja kaitsmiseks on märgitud sissejuhatavatel slaididel. Pärast antud kuupäeva kodutöid esitada ei ole võimalik!

Esitamine

Esitada tuleb dokumentatsioon Adobe PDF formaadis, kõik vajalikud koodifailid programmi kompileerimiseks ning arhiiv testsisenditega, kuhu oled lisanud ka enda loodud sisendfaile.

Failide nimed peavad algama Kodutoo_II_Eesnimi_Perenimi_üliõpilaskood.
Näiteks:

Kodutoo_II_Anti_Tiib_112211IACB_kood.c
Kodutoo_II_Anti_Tiib_112211IACB_aruanne.pdf
Kodutoo_II_Anti_Tiib_112211IACB_sisendid.zip

Kodutöö tuleb esitada Moodle kaudu: https://moodle.taltech.ee/mod/assign/view.php?id=565109

Tulemused ja tagasiside

Pärast töö kontrollimist leiad Moodlest oma punktid ning tagasiside (nähtav vaid hinnetelehet!). Korralikult tehtud töö korral võib tagasiside puududa.

Kodutöö parandamine

Kodutöö tulemust on võimalik parandada kuni kodutööde lukustamise kuupäevani. Parandatud kodutööd kuuluvad kaitsmisele.

Kodutöö parandamiseks vaata esmalt läbi oma töö tagasiside. Seejärel võta ühendust õppejõuga, et kokku leppida parandamise protsessis.

NB! Kui töö parandamise käigus osutub vajalikuks enama kui poole töö muutmine, loetakse seda uue töö esitamiseks, millelt võidakse arvestada maha miinuspunktid vastavalt esitamise ajale.

NB! Tegu on vaid osalise lahendusega demonstreerimaks üldist kodutöö struktuuri, sisestust, testimist ja koodimisstiili. Konkreetsete nõuete kohta loe nõuete alt!

Koodinäidise vaatamiseks kliki siin

/**
 * Author:          Risto Heinsar
 * Created:         23.10.2015
 * Modified:        19.10.2022
 * Description:     This snippet of code helps Nick Fury keep track of his
 *                  minions a little better.
 */

#include <stdio.h>

// constants
#define MIN_AVENGERS 1
#define MAX_AVENGERS 10
#define NAME_LIM 15


// function prototypes
int GetAvengerCount(int minVal, int maxVal);
void FillMissionStats(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],
                      int listLen);
double FindAvgBaddieDisposedOf(int disposeCount[], int listLen);
void DisplaySlackers(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],
                     int avengerCount, double avgBaddiesDisposed);

int main(void)
{
    double avgBaddiesDisposed;
    char avengers[MAX_AVENGERS][NAME_LIM];
    int disposeCount[MAX_AVENGERS];

    // Get number of avengers participating in the mission
    int avengerCount = GetAvengerCount(MIN_AVENGERS, MAX_AVENGERS);

    // Collect mission statistics
    FillMissionStats(avengers, disposeCount, avengerCount);
 
    // Data processing and output
    avgBaddiesDisposed = FindAvgBaddieDisposedOf(disposeCount, avengerCount);
    DisplaySlackers(avengers, disposeCount, avengerCount, avgBaddiesDisposed);

    return 0;
}

/**
 * Description: Prompts for an integer within the allowed range. Only returns
 *              once user input is within the range, otherwise prints an error
 *              and reprompts.
 * 
 * Parameters:  minVal - lower limit for allowed range (inclusive)
 *              maxVal - upper limit for allowed range (inclusive)
 * 
 * Return:      Integer within the allowed range.
 */
int GetAvengerCount(int minVal, int maxVal)
{
    int count;
    
    do
    {
        printf("Enter avenger count between %d and %d\n", minVal, maxVal);
        scanf("%d", &count);
        
        // Print an error for invalid input
        if (count < minVal || count > maxVal)
            puts("I'm sorry, I can't handle that :(");
    }
    while (count < minVal || count > maxVal);
    
    return count;
}


/**
 * Description: Populates the mission figures - the names of avengers who were
 *              on the mission and how many baddies they disposed of. Assumes
 *              both arrays use the same index for corresponding values.
 * 
 * Parameters:  avenger - 2D array for avenger names
 *              disposeCount - number of baddies disposed by each avenger
 *              listLen - number of avengers on the mission
 * 
 * Return:      none
 */
void FillMissionStats(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],
                      int listLen)
{
    int i;
    for (i = 0; i < listLen; i++)
    {
        printf("Enter the name and disposed of count for avenger %d: ", i + 1);
        scanf("%s %d", avenger[i], &disposeCount[i]);
    }
}

 
/**
 * Description: Finds the average number of baddies disposed on a mission
 *              per avenger.
 * 
 * Parameters:  disposeCounts - number of baddies disposed by each avenger
 *              listLen - number of avengers on the mission
 * 
 * Return:      float, number of baddies disposed of on average
 */
double FindAvgBaddieDisposedOf(int disposeCount[], int listLen)
{
    int i;
    int sum = 0;
    
    // Find the total baddies disposed of
    for (i = 0; i < listLen; i++)
    {
        sum += disposeCount[i];
    }
    
    // returns the average
    return ((double)sum / (double)listLen);
}

/**
 * Description: Prints the mission statistics, finds the avengers who were
 *              were goofing off and reports them to Fury.
 * 
 * Parameters:  avenger - 2D array for avenger names
 *              disposeCount - number of baddies disposed by each avenger
 *              avengerCount - number of avengers on the mission
 *              avgBaddiesDisposed - average number of baddies disposed by 
 *                                   one avenger during the mission
 * 
 * Return:      none
 */
void DisplaySlackers(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],
                     int avengerCount, double avgBaddiesDisposed)
{
    int i;
    
    printf("Total number of avengers in mission was %d\n", avengerCount);
    printf("Average baddies disposed of was: %lg\n\n", avgBaddiesDisposed);
    
    printf("The following avengers were slacking off:\n");
    
    // Go through the list of avengers
    for (i = 0; i < avengerCount; i++)
    {
        // Print if avenger disposed of less baddies than the average
        if (disposeCount[i] < avgBaddiesDisposed)
        {
            printf("%15s %3d\n", avenger[i], disposeCount[i]);
        }
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

/**

* Author: Risto Heinsar

* Created: 23.10.2015

* Modified: 19.10.2022

* Description: This snippet of code helps Nick Fury keep track of his

* minions a little better.

#include <stdio.h>

// constants

#define MIN_AVENGERS 1

#define MAX_AVENGERS 10

#define NAME_LIM 15

// function prototypes

int GetAvengerCount(int minVal, int maxVal);

void FillMissionStats(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],

int listLen);

double FindAvgBaddieDisposedOf(int disposeCount[], int listLen);

void DisplaySlackers(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],

int avengerCount, double avgBaddiesDisposed);

int main(void)

{

double avgBaddiesDisposed;

char avengers[MAX_AVENGERS][NAME_LIM];

int disposeCount[MAX_AVENGERS];

// Get number of avengers participating in the mission

int avengerCount = GetAvengerCount(MIN_AVENGERS, MAX_AVENGERS);

// Collect mission statistics

FillMissionStats(avengers, disposeCount, avengerCount);

// Data processing and output

avgBaddiesDisposed = FindAvgBaddieDisposedOf(disposeCount, avengerCount);

DisplaySlackers(avengers, disposeCount, avengerCount, avgBaddiesDisposed);

return 0;

}

/**

* Description: Prompts for an integer within the allowed range. Only returns

* once user input is within the range, otherwise prints an error

* and reprompts.

* Parameters: minVal - lower limit for allowed range (inclusive)

* maxVal - upper limit for allowed range (inclusive)

* Return: Integer within the allowed range.

int GetAvengerCount(int minVal, int maxVal)

{

int count;

{

printf("Enter avenger count between %d and %d\n", minVal, maxVal);

scanf("%d", &count);

// Print an error for invalid input

if (count < minVal || count > maxVal)

puts("I'm sorry, I can't handle that :(");

}

while (count < minVal || count > maxVal);

return count;

}

/**

* Description: Populates the mission figures - the names of avengers who were

* on the mission and how many baddies they disposed of. Assumes

* both arrays use the same index for corresponding values.

* Parameters: avenger - 2D array for avenger names

* disposeCount - number of baddies disposed by each avenger

* listLen - number of avengers on the mission

* Return: none

void FillMissionStats(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],

int listLen)

{

int i;

for (i = 0; i < listLen; i++)

{

printf("Enter the name and disposed of count for avenger %d: ", i + 1);

scanf("%s %d", avenger[i], &disposeCount[i]);

}

/**

* Description: Finds the average number of baddies disposed on a mission

* per avenger.

* Parameters: disposeCounts - number of baddies disposed by each avenger

* listLen - number of avengers on the mission

* Return: float, number of baddies disposed of on average

double FindAvgBaddieDisposedOf(int disposeCount[], int listLen)

{

int i;

int sum = 0;

// Find the total baddies disposed of

for (i = 0; i < listLen; i++)

{

sum += disposeCount[i];

}

// returns the average

return ((double)sum / (double)listLen);

}

/**

* Description: Prints the mission statistics, finds the avengers who were

* were goofing off and reports them to Fury.

* Parameters: avenger - 2D array for avenger names

* disposeCount - number of baddies disposed by each avenger

* avengerCount - number of avengers on the mission

* avgBaddiesDisposed - average number of baddies disposed by

* one avenger during the mission

* Return: none

void DisplaySlackers(char avenger[MAX_AVENGERS][NAME_LIM], int disposeCount[],

int avengerCount, double avgBaddiesDisposed)

{

int i;

printf("Total number of avengers in mission was %d\n", avengerCount);

printf("Average baddies disposed of was: %lg\n\n", avgBaddiesDisposed);

printf("The following avengers were slacking off:\n");

// Go through the list of avengers

for (i = 0; i < avengerCount; i++)

{

// Print if avenger disposed of less baddies than the average

if (disposeCount[i] < avgBaddiesDisposed)

{

printf("%15s %3d\n", avenger[i], disposeCount[i]);

}

Testimiseks kasutan mitut erinevat andmefaili katmaks erinevaid olukordi, mis tekkida võivad.

Test 1

4
Hulk 19
Thor 4
Cpt.America 12
Hawkeye 6

Hulk 19

Thor 4

Cpt.America 12

Hawkeye 6

Testimisprotsess väljundiga

Test 2

19
0
-5
5
Falcon 2
Hulk 24
Thor 3
Cpt.America 5
Hawkeye 21

-5

Falcon 2

Hulk 24

Thor 3

Cpt.America 5

Hawkeye 21

Testimisprotsess väljundiga