SDA Lucrarea 5

În acest laborator se vor implementa mulțimi cu funcții hash și arbori binari.

Mulțimea

Mulțimea este o structură de date abstractă care stochează o colecție de elemente unice în care ordinea nu contează.

Mulțimea are următoarele proprietăți:

1. Datele sunt plasate într-o ordine oarecare stabilită arbitrar de structură.
2. Numărul de elemente ce poate fi stocat de structură este nelimitat.
3. Elementele stocate în mulțime sunt de același fel.
4. Mulțimea poate conține doar elemente unice, în baza unei funcții definite de egalitate. Altfel spus, dacă două elemente sunt egale din punctul de vedere al mulțimii, ele nu pot fi ambele conținute de mulțime.

Mulțimea suportă următoarele operații de bază:

1. Interogarea numărului de elemente din mulțime.
2. Verificarea dacă mulțimea este goală.
3. Adăugarea unui element în mulțime (insert).
4. Verificarea dacă un element există în mulțime (count).
5. Eliminarea unui element din mulțime (erase).

Pentru a verifica egalitatea a două elemente vom defini o funcție equals care va întoarce true dacă cele două argumente sunt egale și false dacă nu. Această funcție trebuie să existe pentru orice implementare de mulțime, atunci când elementele nu sunt valori ce pot fi comparate cu operatorul implicit ==:

namespace std {
    /**
     * Functia verifica daca valorile value1 si value2 sunt egale.
     * @param value1 prima valoare de comparat.
     * @param value2 a doua valoare de comparat.
     * @return true daca cele doua valori sunt egale si false in rest.
     */
    bool equal(T value1, T value2);
}

Atenție, pentru a putea fi folosită de clasele de tip mulțime din STL, această funcție trebuie declarată în interiorul namespace-ului std.

Implementarea de mulțimi cu funcții hash

O funcție hash este o funcție care ia ca argument un șir de bytes de orice dimensiune și întoarce un șir de bytes 
de dimensiune fixă ce poartă numele de valoare de hash, cod hash sau pur și simplu hash.

Definiția unei funcții hash este strâns legată de definiția funcției equal astfel încât dacă două elemente e1 și e2 sunt considerate egale (equal(e1, e1) == true), atunci obligatoriu hash(e1) == hash(e2):

namespace std {
    template<class T> 
    struct hash {
        /**
         * Metoda calculeaza un hashcode pentru elementul element.
         * @param element referinta la un element de tip T pentru care se calculeaza hash-ul
         * @return hashcode-ul calculat.
         */
        std::size_t operator()(T const& element) const;
    };
}

Să definim noile elemente de sintaxă:

1. std::size_t este un tip de dată ce reprezintă o dimensiune (deci este un număr întreg fără semn), iar dimensiunea lui în biți depinde de compilator (poate fi sinonim cu uint32_t sau cu uint64_t); un cod hash este reprezentat ca o valoare de tip std::size_t
2. operator() este numele unui operator (mai precis operatorul 'paranteză rotundă') care poate fi supraîncărcat astfel încât să facă altceva decât comportamentul obișnuit (adică apel de funcție); în acest caz, se poate folosi sintaxa hash<SomeType>(someValueOfSomeType) pentru a apela metoda operator() din structura hash<T>
3. T const &element conține două elemente de noutate:
   • cuvântul cheie const face ca elementul să nu poată fi modificat de metodă (ci doar citit)
   • operatorul & se numește referință, similară cu un pointer, iar scopul lui în acest context este să permită accesarea datelor din variabila element fără a copia tot conținutul structurii pe stivă, lucru care se întâmplă cu variabilele non-referință trimise ca argument funcțiilor.
4. cuvântul cheie const de la sfârșitul metodei specifică faptul că această metodă nu poate modifica membrii clasei (în acest caz clasa nu are alți membri, deci prezența acestui cuvânt cheie este redundantă).

Clasa std::unordered_set

Clasa din STL care implementează mulțimi folosind funcții hash poartă numele de std::unordered_set și este definită în header-ul unordered_set. Mai departe vom exemplifica definirea funcțiilor de egalitate și hash pentru utilizarea unui std::unordered_set în scopul stocării unor elemente de tip struct Person:

struct Person {
    char firstName[30];
    char lastName[30];
    char idNumber[9]; // seria si numarul de buletin
    char address[255];
    char birthday[11];
    char cnp[14];
};

Pentru a implementa o funcție hash pentru variabilele de tip struct Person, avem întâi nevoie să definim operația de egalitate. O persoană își poate schimba numele, buletinul și adresa, și pot exista mai multe persoane cu aceeași dată de naștere, dar ceea ce identifică clar o persoană este codul numeric personal (CNP). Deci vom defini funcția equal să întoarcă 1 dacă cnp-urile celor două argumente de tip struct Person sunt identice:

namespace std {
    /**
     * Functia intoarce true daca CNP-urile celor doua persoane sunt egale.
     * @param person1 prima persoana de comparat.
     * @param person2 a doua persoana de comparat.
     * @return true daca CNP-urile celor doua persoane sunt identice.
     */
    template<>
    bool equal<Person>(Person person1, Person person2) {
        return strcmp(person1.cnp, person2.cnp) == 0;
    }

Mai departe definim funcția hash pentru o Persoană.

Pentru a putea implementa o mulțime cu funcții hash trebuie ca hash-ul maxim să fie o valoare rezonabilă pentru a putea aloca memorie cu dimensiunea valorii respective.

Din motivul de mai sus, și pentru a micșora posibilitatea unei coliziuni de hash ce va micșora performanța structurii, ieșirea funcției hash va fi un număr între 0 și 999999 obținut din ultimele 6 cifre ale CNP-ului convertite din text în număr (pentru conversie puteți folosi funcția atoi):

namespace std {
    template<>
    struct hash<Person> {
        /**
         * Functie hash pentru structurile de tip Person.
         * @param person peroana pentru care se doreste codul hash.
         * @return codul hash al persoanei person
         */
        size_t operator()(Person const & person) const {
            return (size_t) atoi(person.cnp + 7);
        }
    };
    
}

Crearea unui std::unordered_set

Pentru instanțierea unui obiect de tip std::unordered_set, se folosește constructorul fără argumente:

#include<unordered_set>
#include<cstdio>

int main() {
    std::unorder_set<int> mySet;
    printf("My set is empty: %d\n", mySet.empty());
    return 0;
}

Interogarea numărului de elemente din mulțime

Pentru interogarea numărului de elemente din mulțime aunt definite:

/**
 * Functia intoarce numarul de elemente din multime.
 * @return numarul de elemente din multime.
 */
size_t size();

/**
 * Functia intoarce true daca multimea e goala.
 * @return true daca multimea e goala
 */
bool empty();

Exemplu:

#include<unordered_set>
#include<cstdio>

int main() {
    std::unorder_set<float> mySet;
    mySet.insert(1);
    mySet.insert(1.1);
    mySet.insert(1);

    printf("My set has %u elements. My set is empty: %d\n", mySet.size(), mySet.empty());
    return 0;
}

Adăugarea unui element în mulțime

Pentru operația de adăugare se definește următoarea funcție:

/**
 * Functia adauga elementul dat in multime daca acesta nu exista. Daca
 *  exista deja, functia nu are nici un efect.
 * @param element elementul ce trebuie adaugat.
 */
void insert(T element);

Exemplu:

#include<unordered_set>
#include<cstdio>

int main() {
    std::unorder_set<float> mySet;
    mySet.insert(1);
    mySet.insert(1.1);
    mySet.insert(1);

    printf("My set has %u elements. My set is empty: %d\n", mySet.size(), mySet.empty());
    return 0;
}

Eliminarea unui element din mulțime

Pentru operația de eliminare se definește următoarea funcție:

/**
 * Functia elimina elementul dat din multime daca acesta exista. Daca
 *  nu exista, functia nu are nici un efect.
 * @param element elementul ce trebuie eliminat.
 */
void erase(T element);

Exemplu:

#include<unordered_set>
#include<cstdio>

int main() {
    std::unorder_set<float> mySet;
    mySet.insert(1);
    mySet.insert(1.1);
    mySet.insert(1);

    printf("My set has %u elements. My set is empty: %d\n", mySet.size(), mySet.empty());

    mySet.erase(1);

    printf("My set has %u elements. My set is empty: %d\n", mySet.size(), mySet.empty());

    return 0;
}

Verificarea dacă un element există în mulțime

Pentru a verifica dacă un element există în mulțime, se definește următoarea metodă:

/**
 * Metoda intoarce 1 daca elementul specificat exista in multime, 0 dacă nu.
 * @param element elementul cautat.
 * @return 1 daca elementul exista in multime, 0 daca nu.
 */
size_t count(T element);

Exemplu:

#include<unordered_set>
#include<cstdio>

int main() {
    std::unorder_set<float> mySet;
    mySet.insert(1);
    mySet.insert(1.1);
    mySet.insert(1);

    printf("Element %f is in set (0 or 1): %d\n", 1, mySet.count(1));
    printf("Element %f is in set (0 or 1): %d\n", 2, mySet.count(2));
    return 0;
}

Exerciții

Săptămâna 1

1. Dându-se fișierele Fișier:LinkedList.h, Fișier:LinkedList.c și header-ele hashSet.h și person.h de mai jos, implementați toate funcțiile definite în două fișiere sursă numite person.c și hashSet.c:
   • person.h:

     #ifndef PERSON_H
     #define PERSON_H
     
     struct Person {
         char firstName[30];
         char lastName[30];
         char idNumber[9]; // seria si numarul de buletin
         char address[255];
         char birthday[11];
         char cnp[14];
     };
     
     /**
      * Functia intoarce 1 daca CNP-urile celor doua persoane sunt egale.
      * @param person1 prima persoana de comparat.
      * @param person2 a doua persoana de comparat.
      * @return 1 daca CNP-urile celor doua persoane sunt identice.
      */
     char equals(struct Person person1, struct Person person2);
     
     /**
      * Functie hash pentru structurile de tip Person.
      * @param person peroana pentru care se doreste codul hash.
      * @return codul hash al persoanei person
      */
     unsigned hash(struct Person person);
     
     #define T struct Person
     
     #endif
     

   • hashset.h:

     #ifndef HASH_SET_H
     #define HASH_SET_H
     
     #include "linkedList.h"
     #include "person.h"
     
     #define MAX_HASH 1000000
     
     struct HashSet {
         struct LinkedList array[MAX_HASH]; // un vector de liste, una pentru fiecare valoare posibila de hash
         unsigned size; // numarul de elemente din multime
     };
      
     /**
      * Functia creeaza un hashSet nou si intoarce adresa de memorie alocata.
      * @return un pointer la o structura de tip HashSet.
      */
     struct HashSet * createHashSet();
      
     /**
      * Functia intoarce numarul de elemente din multime.
      * @param set multimea a carei dimensiuni este ceruta.
      * @return numarul de elemente din multime.
      */
     unsigned hashSetSize(struct HashSet * set);
      
     /**
      * Functia intoarce 1 dacă mulțimea nu conține nici un element.
      * @param set multimea de interes.
      * @return 1 dacă mulțimea este goală, 0 în rest.
      */
     char hashSetIsEmpty(struct HashSet * set);
      
     /**
      * Functia adauga elementul dat in multime daca acesta nu exista. Daca
      *  exista deja, functia nu are nici un efect.
      * @param set multimea in care trebuie adaugat elementul.
      * @param person elementul ce trebuie adaugta.
      */
     void hashSetPut(struct HashSet * set, struct Person person);
      
     /**
      * Functia elimina elementul dat din multime daca acesta exista. Daca
      *  nu exista, functia nu are nici un efect.
      * @param set multimea din care trebuie eliminat elementul.
      * @param person elementul ce trebuie eliminat.
      */
     void hashSetRemove(struct HashSet * set, struct Person person);
      
     /**
      * Functia intoarce 1 daca elementul specificat exista in multime.
      * @param set multimea in care se cauta elementul.
      * @param person elementul cautat.
      * @return 1 daca elementul exista in multime, 0 daca nu.
      */
     char hashSetContains(struct HashSet * set, struct Person person);
      
     /**
      * Functia sterge hash set-ul specificat.
      * @param set hash set-ul ce trebuie sters.
      */
     void deleteHashSet(struct HashSet * set);
      
     #endif
     

2. Scrieți o altă sursă main.c în care să definiți o funcție struct Person readFromKeyboard() și o altă funcție main care să citească persoane de la tastatură până când numele introdus este egal cu "-" și care să afișeze câte persoane diferite au fost introduse.

Săptămâna 2

1. Dându-se header-ele treeSet.h și server.h de mai jos, implementați toate funcțiile definite în două fișiere sursă numite server.c și treeSet.c:
   • server.h:

     #ifndef SERVER_H
     #define SERVER_H
     
     struct Server {
         /* Numele server-ului in retea - sir de caractere */
         char hostname[30]; 
      
         /* Adresa IP a server-ului o secvență de 4 valori numerice între 0 și 255 (ex: 192.168.1.10) */
         unsigned char ipv4[4];
      
         /* Adresa hardware pentru adaptorul de retea - o secventa de 6 bytes, in hexa (ex: 60:57:18:6e:a8:e8). */
         char hardwareAddress[6];
      
         /* Tipul procesorului - sir de caractere. */
         char cpuType[10];
      
         /* Frecventa procesorului in Gigahertz. */
         float cpuFrequencyGhz;
      
         /* Cantitatea de memorie RAM, in Gigabytes. */
         float ramMemoryGigaBytes;
      
         /* Capacitatea discului, in Terabytes. */
         float diskCapacityTeraBytes;
     };
     
     /**
      * Compara server1 cu server2 si intoarce o valoare corespunzătoare.
      * @param server1 primul server de comparat.
      * @param server2 al doilea server de comparat.
      * @return o valoare pozitivă dacă primul server are o adresa hardware mai mare, o 
      *  valoare negativă dacă al doilea server are o adresa hardware mai mare și 0 dacă
      *  adresele hardware sunt egale.
      */
     int compare(struct Server server1, struct Server server2);
     
     #endif
     

   • treeSet.h:

     #ifndef TREE_SET_H
     #define TREE_SET_H
     
     #include "server.h"
     
     struct TreeNode {
         struct TreeNode * parent;
         struct TreeNode * left;
         struct TreeNode * right;
         struct Server value;
     };
      
     struct TreeSet {
         struct TreeNode * root;
         unsigned size;
     };
      
     /**
      * Functia aloca memorie si intoarce un pointer la un nou TreeSet.
      * @return adresa noului TreeSet.
      */
     struct TreeSet * createTreeSet();
      
     /**
      * Functia intoarce numarul de elemente din multime.
      * @param set multimea a carei dimensiuni este ceruta.
      * @return numarul de elemente din multime.
      */
     unsigned treeSetSize(struct TreeSet * set);
      
     /**
      * Functia intoarce 1 dacă mulțimea nu conține nici un element.
      * @param set multimea de interes.
      * @return 1 dacă mulțimea este goală, 0 în rest.
      */
     char treeSetIsEmpty(struct TreeSet * set);
      
     /**
      * Functia adauga elementul dat in multime daca acesta nu exista. Daca
      *  exista deja, functia nu are nici un efect.
      * @param set multimea in care trebuie adaugat elementul.
      * @param server elementul ce trebuie adaugat.
      */
     void treeSetPut(struct TreeSet * set, struct Server server);
      
     /**
      * Functia elimina elementul dat din multime daca acesta exista. Daca
      *  nu exista, functia nu are nici un efect.
      * @param set multimea din care trebuie eliminat elementul.
      * @param server elementul ce trebuie eliminat.
      */
     void treeSetRemove(struct TreeSet * set, struct Server server);
      
     /**
      * Functia intoarce 1 daca elementul specificat exista in multime.
      * @param set multimea in care se cauta elementul.
      * @param server elementul cautat.
      * @return 1 daca elementul exista in multime, 0 daca nu.
      */
     char treeSetContains(struct TreeSet * set, struct Server server);
      
     /**
      * Functia sterge tree set-ul specificat.
      * @param set tree set-ul ce trebuie sters.
      */
     void deleteTreeSet(struct TreeSet * set);
      
     #endif
     

2. Scrieți o altă sursă main.c în care să definiți o funcție struct Server readFromKeyboard() și o altă funcție main care să citească informații legate de servere de la tastatură până când hostname-ul introdus este egal cu "-" și care să afișeze câte servere diferite au fost introduse.