VAATIMUSMÄÄRITTELY. PROJEKTITYÖ Tik Wclique

Transkriptio

1 VAATIMUSMÄÄRITTELY PROJEKTITYÖ Tik

2 SISÄLLYSLUETTELO Sisällysluettelo... 2 Versiohistoria JOHDANTO Algoritmi Graafi Nauty Mermaid YLEISKUVAUS TOIMINNOT ja VAATIMUKSET Painottamattomien graafien vaatimukset Painottamattoman maksimiklikin koko Yhden maksimiklikin laskeminen Kaikkien maksimiklikkien laskeminen Yhden klikin laskeminen kokoa S Kaikkien klikkien laskeminen kokoa S Yhden klikin laskeminen vähintään kokoa S Kaikkien klikkien laskeminen vähintään kokoa S Solmujen järjestäminen Ensisijaiset "olisi hienoa" -ominaisuudet Klikkien laskenta annetulla solmujen määrällä Painotettujen graafien vaatimukset Painotetun maksimiklikin koko Yhden maksimiklikin laskeminen Kaikkien maksimiklikkien laskeminen Yhden klikin laskeminen kokoa S Kaikkien klikkien laskeminen kokoa S Yhden klikin laskeminen vähintään kokoa S Kaikkien klikkien laskeminen vähintään kokoa S Eri syöteformaattien lukeminen Solmujen järjestäminen MUUT OMINAISUUDET Tehokkuus ja käytettävyys Kieli ja kieliasu Siirrettävyys Käyttökirja Testaaminen Jatkokehitys Liite: Use Case kuva... 11

3 VERSIOHISTORIA Versio Päivämäärä Laatija Kuvaus Dufva Proposal Dufva First draft Dufva Second draft Dufva Third draft Dufva Fourth draft Dufva Edited according to comments received from Patric Östergård and Harri Haanpää

4 VAATIMUSMÄÄRITTELY 4 (11) 1. JOHDANTO Tässä dokumentissa kuvataan ohjelman asiakkaan vaatimuksia. Dokumentti koostuu johdannosta, jonka alaotsikoissa on kerrottu termeistä, jotka saattavat olla ennestään vieraita. Yleiskuvauksessa on mainittu toteutustyökalut, liittymät muihin ohjelmiin ja käyttöympäristön. Toiminnot luvussa kuvataan järjestelmältä vaadittavat ominaisuudet yleisellä tasolla. Neljännessä luvussa mainitaan muista ohjelman ominaisuuksista kuten suorituskykytoiveista ja käytettävyydestä. Liitteenä on Mermaid -ohjelmalla muodostettu UML -kuvaus ohjelman vaatimuksista. Se että käytetäänkö UML -kuvausta toiminnallisessa määrittelyssä on epävarmaa, koska vaatimukset ovat tyypiltään sellaisia, ettei UML anna toiminnalliseen määrittelyyn suurta informatiivista hyötyä. Tavoitteena -ohjelmassa on muodostaa algoritmille toimiva ympäristö, jolloin algoritmin käyttö helpottuu ja algoritmille voidaan luoda uusia käyttötapoja. Ohjelmasta on olemassa jo alustava prototyyppi, jossa on jo jotain ominaisuuksia painavimman klikin löytämiseksi. Sen voi ladata osoitteesta: ~ pat/wclique.html 1.1 Algoritmi Algoritmi jonka ympärille ohjelma rakennetaan on julkinen ja algoritmin toimintaa on kuvattu Internetissä seuraavissa dokumenteissa: "A Fast Algorithm for the Maximum Clique Problem" ~ pat/paper1.ps "A New Algorithm for the Maximum-Weight Clique Problem" ~ pat/paper2.ps Algoritmilla voidaan ratkaista olemassa olevasta graafista asioita joista ollaan kiinnostuneita. Luvussa 1.2 on lyhyt selvitys siitä mikä on graafi. Algoritmi on muodostettu pseudokielellä ja yksi projektin kohteista on muuttaa se C -kielellä toimivaksi. 1.2 Graafi Useissa yhteyksissä tarkastellaan joukkoa solmuja tai tiloja, joista joko on tai ei ole mahdollista siirtyä välittömästi toinen toisiinsa. Tyypillisiä esimerkkejä tällaisista ovat kartta, johon on merkitty kaupunkeja, sekä näiden väliset suorat liikenneyhteydet, tietokoneohjelman kulkua kuvaava vuokaavio ja sukupuut. Graafi, eli verkko G = ( V, E ) muodostuu äärellisistä joukoista V ja E, joista V on ns. solmujen joukko (solmuista

5 VAATIMUSMÄÄRITTELY 5 (11) käytetään myös joissain yhteyksissä nimityksiä kärki tai piste), ja E on sivujen joukko (käytössä myös nimitykset kaari ja haara). Jotta edellinen lause hiukan selkenisi niin Kuva 1 on esitetty kaksi graafia. A-graafi on painottamaton (unweighted) ja b-graafi on painotettu (weighted), jossa solmun paino on sulkujen sisällä. Klikki tarkoittaa yhteyttä usean solmun välillä. ohjelma ei ota kantaa, kuten Nauty ohjelma, siihen onko graafi suunnattu vai suuntaamaton. A-kohdassa maksimiklikin koko on kuusi, b-kohdan graafin maksimiklikin koko on (1) 2 3 2(8) 3(2) 4 5 4(6) 5(4) 6 Graafi a 6(5) Graafi b Kuva 1. Kaksi graafia. 1.3 Nauty Nauty on C kielellä tehty ohjelma jolla voidaan muodostaa automorfisia ryhmiä sekä graafeille että suunnatuille graafeille. Se myös pystyy muodostamaan kanonisia nimiöintejä. Nauty on vapaasti tieteellisissä tarkoituksissa käytettävä ohjelma jonka ohjelmakoodi on julkinen. Nauty ohjelma voidaan ladata osoitteesta: Mermaid Mermaid on Nokialla käytetty ohjelma jolla voidaan luoda UML kuvaus ohjelmalle (ks. liitteenä oleva Mermaidilla tehty UML kuvaus vaatimuksista). Ideana on että esim. yhtä vaatimus soikiota klikattaessa, päästään tarkempiin määrittelyihin, jotka kuuluisivat toiminnalliseen määrittelyyn.

6 VAATIMUSMÄÄRITTELY 6 (11) 2. YLEISKUVAUS Projektityön aihe on ohjelma, josta tulee tieteellisessä käytössä vapaasti käytettävä, eli lähdekoodi on julkinen. Ohjelmatyö tehdään Patric Östergårdille, jonka toimittamassa PostScript dokumentissa:, Patric Östergård, September 28, 2000 on määritelty toivomuksia ohjelmasta. Projektityön koodi tehdään Ansi-C muodossa jolloin se on käyttöjärjestelmästä riippumaton. Ohjelmaa käytetään pääasiassa Unix/Linux käyttöjärjestelmässä jolloin pääosin ohjelman testaus tehdään Nokian tietokoneissa, joissa on Linux käyttöjärjestelmä. Tarvittaessa TKK:n Tietojenkäsittelyteorianlaboratorio on myös käytettävissä. Lopuksi pyritään varmistamaan ohjelman toiminta myös Windows pohjaisissa käyttöjärjestelmissä. Syöte jota en annetaan tulee olla ascii- tai binäärimuotoista, komentoriviparametrit ovat asciita. Tuloste jota sta saadaan on asciimuotoista. Kuva 2 on esitetty syöte- ja tulosteformaatit esimerkkigraafista. 4(3) Esimerkkigraafi 1(1) 2(8) 6(6) 8(5) 3(2) 7(4) 5(3) Syöteformaatti (Dimacsin ascii) c input_jd_w c weighted graph p clq 8 20 e 1 2 e 1 3 e 1 6 e 1 7 e 1 8 e 2 3 e 2 4 e 2 5 e 2 6 e 2 7 e 2 8 e 3 5 e 3 6 e 3 7 e 3 8 e 5 6 e 5 7 e 6 7 e 6 8 e 7 8 n 1 1 n 2 8 n 3 2 n 4 3 n 5 3 n 6 6 n 7 4 n 8 5 c input_jd_uw c unweighted graph p clq 8 20 e 1 2 e 1 3 e 1 6 e 1 7 e 1 8 e 2 3 e 2 4 e 2 5 e 2 6 e 2 7 e 2 8 e 3 5 e 3 6 e 3 7 e 3 8 e 5 6 e 5 7 e 6 7 e 6 8 e 7 8 n 1 1 n 2 1 n 3 1 n 4 1 n 5 1 n 6 1 n 7 1 n 8 1 Tulosteformaatti Kuva 2. n syöte- ja tuloste formaatit. Projektityön päätarkoitus ei ole kehittää itse algoritmia. Jos kuitenkin algoritmi tarvitsee pientä "viilaamista", algoritmin muodostamisessa pseudokielestä syntyy ongelmia tai algoritmi tarvitsee jatkokehitystä, niin yhteyshenkilönä asiakkaan puolelta toimii Harri Haanpää.

7 VAATIMUSMÄÄRITTELY 7 (11) 3. TOIMINNOT JA VAATIMUKSET Ensisijainen päämäärä tässä projektissa on muodostaa toimiva käyttöympäristö algoritmille, jota voidaan kutsua toisesta C kielellä tehdystä ohjelmasta komennolla wclique. Tämä tapahtuu tuottamalla aliohjelmakirjasto, jolla voidaan etsiä klikkejä graafeista. Toissijainen tarkoitus on tuottaa aliohjelmakirjastoon perustuva komentoriviltä ajettava ohjelma, joka ratkoo samoja ongelmia. Ohjelman tulee toimia Unix/Linux käyttöjärjestelmässä yhdessä Nauty ohjelman kanssa ilman ongelmia. Alla on esimerkki C kielen rutiini, eli kuinka ohjelmaa voidaan kutsua. #include "wclique.h"... main() {... /* define graph */... wclique(...); /* process results */... } n tulee ainakin sisältää ensisijaiset vaatimukset, jotka käsittelevät painottamattomia ja painotettuja graafeja (kappaleet ja ). Kuvassa 1 on esitetty mitä tarkoitetaan painotetulla ja painottamattomalla graafilla. 3.1 Painottamattomien graafien vaatimukset Painottamattoman maksimiklikin koko Haluttaessa tietää graafin ominaisuuksista maksimiklikin koko, ohjelman tulee hakea se. tulostaa vastauksena solmujen määrän Yhden maksimiklikin laskeminen -ohjelman tulee laskea pyydettäessä yksi maksimiklikki Kaikkien maksimiklikkien laskeminen -ohjelman tulee laskea pyydettäessä kaikki maksimiklikit.

8 VAATIMUSMÄÄRITTELY 8 (11) Yhden klikin laskeminen kokoa S n tulee hakea yhden luokkaa S olevan klikin solmupisteet Kaikkien klikkien laskeminen kokoa S n tulee hakea kaikkien niiden klikkien solmupisteet, jotka ovat kooltaan luokkaa S Yhden klikin laskeminen vähintään kokoa S n tulee hakea solmupisteet yhdestä klikistä joka on vähintään luokkaa S Kaikkien klikkien laskeminen vähintään kokoa S n tulee hakea kaikkien niiden klikkien solmupisteet, jotka ovat kooltaan vähintään luokkaa S. Kohdissa mainituista kaikkien klikkien laskemisesta: Jos halutaan vain yksi tietynlainen klikki, ohjelma tulostaa sen. Jos pyydetään ohjelmaa hakemaan kaikki tiettyä tyyppiä olevat klikit ei tällainen lähestymistapa välttämättä ole mahdollinen (niitä voi olla miljoonittain). Silloin ohjelma kutsuu jokaisen löydetyn klikin kohdalla funktion. Tämän funktion nimi on wclique- rutiinin parametreina ja käyttäjä luo itse kyseisen funktion. Vrt. qsort() lajittelurutiini C-kielessä missä funktio, joka vertaa kahta alkiota, on annettu parametrina Solmujen järjestäminen n pitää pystyä järjestämään uudelleen graafin solmut Ensisijaiset "olisi hienoa" -ominaisuudet Klikkien laskenta annetulla solmujen määrällä n tulisi laskea yksi tai kaikki klikit annetulla solmujen määrällä, tietyin määrävälein, esimerkiksi: : 2 solmua : 3 solmua Tämä vaatimus on ns. "Olisi hienoa" -ominaisuus ja ei kuulu ehdottomasti vaadittuihin ohjelman ominaisuuksiin.

9 VAATIMUSMÄÄRITTELY 9 (11) 3.2 Painotettujen graafien vaatimukset Painotetun maksimiklikin koko Haluttaessa tietää graafin ominaisuuksista maksimiklikin koko, ohjelman tulee hakea se. Tulosteena palauttaa maksimiklikin painoarvon Yhden maksimiklikin laskeminen -ohjelman tulee laskea pyydettäessä yksi maksimiklikki Kaikkien maksimiklikkien laskeminen -ohjelman tulee laskea pyydettäessä kaikki maksimiklikit Yhden klikin laskeminen kokoa S n tulee hakea yhden luokkaa S olevan klikin solmupisteet Kaikkien klikkien laskeminen kokoa S n tulee hakea kaikkien niiden klikkien solmupisteet, jotka ovat kooltaan luokkaa S Yhden klikin laskeminen vähintään kokoa S n tulee hakea niiden kaikkien klikkien määrä, jotka ovat kooltaan luokkaa S tai enemmän Kaikkien klikkien laskeminen vähintään kokoa S n tulee hakea kaikkien niiden klikkien solmupisteet, jotka ovat kooltaan vähintään luokkaa S Eri syöteformaattien lukeminen Ohjelman tulee pystyä lukemaan dimacsin ascii ja binaari syöteformaatteja. Syöte ja tulostetiedoston ulkoasu on esitetty kuvassa 2. Tarkempaa tietoa syötteen sisällöstä saa osoitteesta: ~ pat/wclique.html

10 VAATIMUSMÄÄRITTELY 10 (11) Solmujen järjestäminen n pitää pystyä järjestämään uudelleen graafin solmut. 4. MUUT OMINAISUUDET 4.1 Tehokkuus ja käytettävyys Vaatimus n tehokkuus ominaisuuksista on, että ohjelma toimii vähintään yhtä nopeasti kuin Patric Östergårdin n protoversio. Ohjelman käytettävyys tulisi olla samalla tasolla kuin Brendan McKayn Nauty ohjelmassa. 4.2 Kieli ja kieliasu Ohjelmakoodin kommentointi tehdään englanniksi mahdollisimman selkeästi jotta jatkokehitys olisi helppoa ja koodi ymmärrettävää. 4.3 Siirrettävyys Tuotteen on oltava arkkitehtuuri riippumaton ja vaivattomasti käännettävissä ANSI C yhteensopivalla kääntäjällä erilaisissa Unix-koneissa ja mielellään myös Windows-koneissa. 4.4 Käyttökirja Käyttökirja toimitetaan englannin kielellä LaTex formaatissa. Käyttökäsikirjassa on selkeästi ja kattavasti dokumentoitava, miten tuotetta käytetään aliohjelmakirjastona ja miten sitä käytetään komentoriviltä. 4.5 Testaaminen Tuote tulee testata huolellisesti. Testaus tulee suorittaa tieteellisesti oikealla tavalla, jotta tulokset ovat luotettavia. 4.6 Jatkokehitys Tehdyt ratkaisut on dokumentoitava niin hyvin että jatkokehittelijä voi pelkän dokumentaation perusteella suunnitella, miten toteuttaa haluamansa muutokset.

11 VAATIMUSMÄÄRITTELY 11 (11) LIITE: USE CASE KUVA Use case kuva ohjelman vaatimuksista.