/usr/include/Bpp/PopGen/DataSet.h is in libbpp-popgen-dev 2.1.0-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 | //
// File DataSet.h
// Author : Sylvain Gaillard
// Last modification : April 4, 2008
//
/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for population genetics analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _DATASET_H_
#define _DATASET_H_
// From the STL
#include <algorithm>
#include <vector>
#include <map>
#include <string>
#include <Bpp/Exceptions.h>
#include <Bpp/Graphics/Point2D.h>
#include <Bpp/Utils/MapTools.h>
// From PopGenLib (local)
#include "Group.h"
#include "Individual.h"
#include "Locality.h"
#include "GeneralExceptions.h"
#include "AnalyzedLoci.h"
#include "AnalyzedSequences.h"
#include "PolymorphismMultiGContainer.h"
#include "PolymorphismSequenceContainer.h"
namespace bpp
{
/**
* @brief The DataSet class.
*
* A DataSet the object that manage every data on which one can compute
* some statistics.
*
* @author Sylvain Gaillard
*/
class DataSet
{
private:
AnalyzedLoci* analyzedLoci_;
AnalyzedSequences* analyzedSequences_;
std::vector<Locality<double>*> localities_;
std::vector<Group*> groups_;
public:
// Constructor and destructor
/**
* @brief Build a new void DataSet.
*/
DataSet();
/**
* @brief Destroy a DataSet.
*/
~DataSet();
/**
* @brief Copy constructor.
*/
DataSet(const DataSet& ds);
DataSet& operator=(const DataSet& ds);
public:
// Methodes
// ** Locality manipulation ***************************************************/
/**
* @brief Add a locality to the DataSet.
*
* @param locality A Locality object.
* @throw BadIdentifierException if the locality's name already exists.
*/
void addLocality(Locality<double>& locality) throw (BadIdentifierException);
/**
* @brief Get the position of a locality in the container.
*
* @return The locality_position (position) of the Locality.
* @param name The locality's name to find.
* @throw LocalityNotFoundException if the locality's name doesn't match any name in the DataSet.
*/
size_t getLocalityPosition(const std::string& name) const throw (LocalityNotFoundException);
/**
* @brief Get a Locality by locality_position.
*
* @return A const pointer to the locality matching the locality_position.
* @param locality_position The position of the Locality in the DataSet.
* @throw IndexOutOfBoundsException if locality_position excedes the number of locality of the DataSet.
*/
const Locality<double>& getLocalityAtPosition(size_t locality_position) const throw (IndexOutOfBoundsException);
/**
* @brief Get a Locality by name.
*
* @throw LocalityNotFoundException if the locality's name is not found.
*/
const Locality<double>& getLocalityByName(const std::string& name) const throw (LocalityNotFoundException);
/**
* @brief Delete a Locality from the DataSet.
*
* @throw IndexOutOfBoundsException if locality_position excedes the number of Locality.
*/
void deleteLocalityAtPosition(size_t locality_position) throw (IndexOutOfBoundsException);
/**
* @brief Delete a Locality from the DataSet.
*
* @throw LocalityNotFoundException if the locality's name is not found.
*/
void deleteLocalityByName(const std::string& name) throw (LocalityNotFoundException);
/**
* @brief Get the number of Localities.
*/
size_t getNumberOfLocalities() const;
/**
* @brief Tell if there is at least one locality.
*/
bool hasLocality() const;
// ** Group manipulation ******************************************************/
/**
* @brief Add a Group to the DataSet.
*
* Add a Group to the DataSet.
*
* @param group A pointer to the Group to add.
*/
void addGroup(const Group& group) throw (BadIdentifierException);
/**
* @brief Add an empty Group to the DataSet.
*/
void addEmptyGroup(size_t group_id) throw (BadIdentifierException);
/**
* @brief Get a group by identifier.
*/
const Group& getGroupById(size_t group_id) const throw (GroupNotFoundException);
/**
* @brief Get the position of a Group.
*
* @throw GroupNotFoundException if the group_id is not found.
*/
size_t getGroupPosition(size_t group_id) const throw (GroupNotFoundException);
/**
* @brief Get the name of a Group. If the name is an empty string it just returns the group_id
*
* @throw GroupNotFoundException if the group_id is not found.
*/
std::string getGroupName(size_t group_id) const throw (GroupNotFoundException);
/**
* @brief set the name of a Group.
*
* @throw GroupNotFoundException if the group_id is not found.
*/
void setGroupName(size_t group_id, const std::string& group_name) const throw (GroupNotFoundException);
/**
* @brief Get a group by position.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
*/
const Group& getGroupAtPosition(size_t group_position) const throw (IndexOutOfBoundsException);
/**
* @brief Delete a Group from the DataSet.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
*/
void deleteGroupAtPosition(size_t group_position) throw (IndexOutOfBoundsException);
/**
* @brief Get the number of Groups.
*/
size_t getNumberOfGroups() const;
/**
* @brief Merge two groups.
*
* This methode merge two groups. The source group is emptied into the target
* and then is deleted.
*/
void mergeTwoGroups(size_t source_id, size_t target_id) throw (GroupNotFoundException);
/**
* @brief Merge some Groups in one.
*
* Merge all the groups which are specified in the first one (smallest
* identifier). When a group is merged to the first, it is deleted from the
* DataSet.
*
* @param group_ids A vector size_t listing the id of groups to merge.
* @throw IndexOutOfBoundsException if one of the int in groups excedes the number of groups.
*/
void mergeGroups(std::vector<size_t>& group_ids) throw (GroupNotFoundException);
/**
* @brief Split a group in two.
*
* @param group_id The identifier of the source group.
* @param individuals_selection The positions of the Individuals to extract from the group to make the new group.
* @throw GroupNotFoundException if the group_id is not found.
* @throw IndexOutOfBoundsException if one position of the selection excedes the number of individuals of the group.
*/
void splitGroup(size_t group_id, std::vector<size_t> individuals_selection) throw (Exception);
// ** Individuals manipulation ************************************************/
/**
* @brief Add an Individual to a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw BadIdentifierException if the individual's id is already in use.
*/
void addIndividualToGroup(size_t group_position, const Individual& individual) throw (Exception);
/**
* @brief Add an empty Individual to a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw BadIdentifierException if the individual's id is already in use.
*/
void addEmptyIndividualToGroup(size_t group_position, const std::string& individual_id) throw (Exception);
/**
* @brief Get the number of Individuals in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
*/
size_t getNumberOfIndividualsInGroup(size_t group_position) const
throw (IndexOutOfBoundsException);
/**
* @brief Get the position of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndividualNotFoundException if individual_id is not found.
*/
size_t getIndividualPositionInGroup(size_t group_position, const std::string& individual_id) const
throw (Exception);
/**
* @brief Get an Individual from a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
const Individual* getIndividualAtPositionFromGroup(size_t group_position, size_t individual_position) const
throw (IndexOutOfBoundsException);
/**
* @brief Get an Individual from a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndividualNotFoundException if individual_id is not found.
*/
const Individual* getIndividualByIdFromGroup(size_t group_position, const std::string& individual_id) const
throw (Exception);
/**
* @brief Delete an Individual from a group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void deleteIndividualAtPositionFromGroup(size_t group_position, size_t individual_position)
throw (IndexOutOfBoundsException);
/**
* @brief Delete an Individual from a group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndividualNotFoundException if individual_id is not found.
*/
void deleteIndividualByIdFromGroup(size_t group_position, const std::string& individual_id)
throw (Exception);
/**
* @brief Set the sex of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void setIndividualSexInGroup(size_t group_position, size_t individual_position, const unsigned short sex)
throw (IndexOutOfBoundsException);
/**
* @brief Get the sex of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
unsigned short getIndividualSexInGroup(size_t group_position, size_t individual_position) const
throw (IndexOutOfBoundsException);
/**
* @brief Set the Date of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void setIndividualDateInGroup(size_t group_position, size_t individual_position, const Date& date)
throw (IndexOutOfBoundsException);
/**
* @brief Get the Date of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no date.
*/
const Date* getIndividualDateInGroup(size_t group_position, size_t individual_position) const
throw (Exception);
/**
* @brief Set the coordinates of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void setIndividualCoordInGroup(size_t group_position, size_t individual_position, const Point2D<double>& coord)
throw (IndexOutOfBoundsException);
/**
* @brief Get the coordinate of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no coordinate.
*/
const Point2D<double>* getIndividualCoordInGroup(size_t group_position, size_t individual_position) const
throw (Exception);
/**
* @brief Set the Locality of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw LocalityNotFoundException if locality_name is not found.
*/
void setIndividualLocalityInGroupByName(size_t group_position, size_t individual_position, const std::string& locality_name)
throw (Exception);
/**
* @brief Get the Locality of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no locality.
*/
const Locality<double>* getIndividualLocalityInGroup(size_t group_position, size_t individual_position) const
throw (Exception);
/**
* @brief Add a Sequence to an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw AlphabetMismatchException if the sequence's alphabet doesn't match the container's alphabet.
* @throw BadIdentifierException if the sequence's name is already in use.
*/
void addIndividualSequenceInGroup(size_t group_position, size_t individual_position,
size_t sequence_position, const Sequence& sequence)
throw (Exception);
/**
* @brief Get a Sequence from an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
* @throw SequenceNotFoundException if sequence_name is not found.
* @throw BadIntegerException if sequence_position is already in use.
*/
const Sequence& getIndividualSequenceByNameInGroup(size_t group_position, size_t individual_position, const std::string& sequence_name) const
throw (Exception);
/**
* @brief Get a Sequence from an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
* @throw SequenceNotFoundException if sequence_position is not found.
*/
const Sequence& getIndividualSequenceAtPositionInGroup(size_t group_position, size_t individual_position, size_t sequence_position) const
throw (Exception);
/**
* @brief Delete a Sequence of an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
* @throw SequenceNotFoundException if sequence_name is not found.
*/
void deleteIndividualSequenceByNameInGroup(size_t group_position, size_t individual_position, const std::string& sequence_name)
throw (Exception);
/**
* @brief Delete a Sequence of an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
* @throw SequenceNotFoundException if sequence_position is not found.
*/
void deleteIndividualSequenceAtPositionInGroup(size_t group_position, size_t individual_position, size_t sequence_position)
throw (Exception);
/**
* @brief Get the Sequences' names from an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
*/
std::vector<std::string> getIndividualSequencesNamesInGroup(size_t group_position, size_t individual_position) const
throw (Exception);
/**
* @brief Get the position of a Sequence in an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
* @throw SequenceNotFoundException if sequence_name is not found.
*/
size_t getIndividualSequencePositionInGroup(size_t group_position, size_t individual_position, const std::string& sequence_name) const
throw (Exception);
/**
* @brief Get the number of Sequences in an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no sequences.
*/
size_t getIndividualNumberOfSequencesInGroup(size_t group_position, size_t individual_position) const
throw (Exception);
/**
* @brief Set the MultilocusGenotype of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void setIndividualGenotypeInGroup(size_t group_position, size_t individual_position, const MultilocusGenotype& genotype)
throw (Exception);
/**
* @brief Initialyze the genotype of an Individual in a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw BadIntegerException if the number of loci is < 1;
* @throw NullPointerException if analyzed_loci is NULL.
* @throw Exception if the individual already has a genotype.
*/
void initIndividualGenotypeInGroup(size_t group_position, size_t individual_position)
throw (Exception);
/**
* @brief Delete the MultilocusGenotype of an Individual from a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
*/
void deleteIndividualGenotypeInGroup(size_t group_position, size_t individual_position)
throw (IndexOutOfBoundsException);
/**
* @brief Set a MonolocusGenotype of an Individual from a group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no genotype.
* @throw IndexOutOfBoundsException if locus_position excedes the number of locus.
*/
void setIndividualMonolocusGenotypeInGroup(size_t group_position, size_t individual_position, size_t locus_position, const MonolocusGenotype& monogen)
throw (Exception);
/**
* @brief Set a MonolocusGenotype of an Individual from a group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no genotype.
* @throw IndexOutOfBoundsException if locus_position excedes the number of locus.
* @throw Exception if the ploidy doesn't match.
*/
void setIndividualMonolocusGenotypeByAlleleKeyInGroup(size_t group_position, size_t individual_position, size_t locus_position, const std::vector<size_t> allele_keys)
throw (Exception);
/**
* @brief Set a MonolocusGenotype of an Individual from a group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no genotype.
* @throw IndexOutOfBoundsException if locus_position excedes the number of locus.
* @throw Exception if there is no key in allele_keys.
*/
void setIndividualMonolocusGenotypeByAlleleIdInGroup(size_t group_position, size_t individual_position, size_t locus_position, const std::vector<std::string> allele_id)
throw (Exception);
/**
* @brief Get a MonolocusGenotype from an Individual of a Group.
*
* @throw IndexOutOfBoundsException if group_position excedes the number of groups.
* @throw IndexOutOfBoundsException if individual_position excedes the number of individual in the group.
* @throw NullPointerException if the individual has no genotype.
* @throw IndexOutOfBoundsException if locus_position excedes the number of locus.
* @throw AlleleNotFoundException if at least one of the id is not found.
*/
const MonolocusGenotype* getIndividualMonolocusGenotypeInGroup(size_t group_position, size_t individual_position, size_t locus_position) const
throw (Exception);
// ** AnalyzedSequences manipulation ******************************************/
/**
* @brief Set the alphabet of the AnalyzedSequences.
*/
void setAlphabet(const Alphabet* alpha);
/**
* @brief Set the alphabet of the AnalyzedSequences by its type..
*/
void setAlphabet(const std::string& alpha_type);
/**
* @brief Get the alphabet if there is sequence data.
*
* @throw NullPointerException if there is no sequence data.
*/
const Alphabet* getAlphabet() const throw (NullPointerException);
/**
* @brief Get the alphabet type as a string.
*
* @throw NullPointerException if there is no sequence data.
*/
std::string getAlphabetType() const throw (NullPointerException);
// ** AnalyzedLoci manipulation ***********************************************/
/**
* @brief Set the AnalyzedLoci to the DataSet.
*
* @throw Exception if at least one Individual has a genotype refering to the actual AnalyzedLoci.
*/
void setAnalyzedLoci(const AnalyzedLoci& analyzedLoci) throw (Exception);
/**
* @brief Initialize the AnalyzedLoci for number of loci.
*
* @throw Exception if the AnalyzedLoci has already been initialyzed.
*/
void initAnalyzedLoci(size_t number_of_loci) throw (Exception);
/**
* @brief Get the AnalyzedLoci if there is one.
*
* @throw NullPointerException if there is no AnalyzedLoci.
*/
const AnalyzedLoci* getAnalyzedLoci() const throw (NullPointerException);
/**
* @brief Delete the AnalyzedLoci.
*/
void deleteAnalyzedLoci();
/**
* @brief Set a LocusInfo.
*
* @throw NullPointerException if there is no AnalyzedLoci to setup.
* @throw IndexOutOfBoundsException if locus_position excedes the total of LocusInfo of the DataSet.
*/
void setLocusInfo(size_t locus_position, const LocusInfo& locus)
throw (Exception);
/**
* @brief Get a LocusInfo by its name.
*/
const LocusInfo& getLocusInfoByName(const std::string& locus_name) const
throw (Exception);
/**
* @brief Get a LocusInfo by its position.
*/
const LocusInfo& getLocusInfoAtPosition(size_t locus_position) const
throw (Exception);
/**
* @brief Add an AlleleInfo to a LocusInfo.
*/
void addAlleleInfoByLocusName(const std::string& locus_name, const AlleleInfo& allele)
throw (Exception);
/**
* @brief Add an AlleleInfo to a LocusInfo.
*/
void addAlleleInfoByLocusPosition(size_t locus_position, const AlleleInfo& allele)
throw (Exception);
/**
* @brief Get the number of loci.
*/
size_t getNumberOfLoci() const throw (NullPointerException);
/**
* @brief Get the ploidy of a locus.
*/
size_t getPloidyByLocusName(const std::string& locus_name) const throw (Exception);
/**
* @brief Get the ploidy of a locus.
*/
size_t getPloidyByLocusPosition(size_t locus_position) const throw (Exception);
// ** Container extraction ***************************************************/
/**
* @brief Get a PolymorphismMultiGContainer with all allelic data of the DataSet.
*/
PolymorphismMultiGContainer* getPolymorphismMultiGContainer() const;
/**
* @brief Get a PolymorphismMultiGContainer from a selection of groups and individuals.
*
* @param selection A map with groups id as keys and vector of individuals position in each group as values.
*/
PolymorphismMultiGContainer* getPolymorphismMultiGContainer(const std::map<size_t, std::vector<size_t> >& selection) const throw (Exception);
/**
* @brief Get a PolymorphismSequenceContainer from a selection of groups and individuals.
*
* All the sequences are ingroup. You may change their state after created the container.
* @param selection A map with groups id as keys and vector of individuals position in each group as values.
* @param sequence_position The position of the sequence in the individuals;
*/
PolymorphismSequenceContainer* getPolymorphismSequenceContainer(const std::map<size_t, std::vector<size_t> >& selection, size_t sequence_position) const throw (Exception);
// ** General tests **********************************************************/
/**
* @brief Tell if at least one individual has at least one sequence.
*/
bool hasSequenceData() const;
/**
* @brief Tell if there is alelelic data.
*/
bool hasAlleleicData() const;
};
} // end of namespace bpp;
#endif // _DATASET_H_
|