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 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
|
/* -*- mode: C -*- */
/*
IGraph library.
Copyright (C) 2005-2012 Gabor Csardi <csardi.gabor@gmail.com>
334 Harvard street, Cambridge, MA 02139 USA
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
*/
#ifndef IGRAPH_ATTRIBUTES_H
#define IGRAPH_ATTRIBUTES_H
#include "igraph_config.h"
#include "igraph_decls.h"
#include "igraph_error.h"
#include "igraph_datatype.h"
#include "igraph_types.h"
#include "igraph_vector.h"
#include "igraph_strvector.h"
#include "igraph_vector_list.h"
#include "igraph_vector_ptr.h"
#include "igraph_iterators.h"
__BEGIN_DECLS
/* -------------------------------------------------- */
/* Attributes */
/* -------------------------------------------------- */
/**
* \section about_attributes
*
* <para>Attributes are numbers or strings (or basically any kind
* of data) associated with the vertices or edges of a graph, or
* with the graph itself. E.g. you may label vertices with symbolic names
* or attach numeric weights to the edges of a graph. </para>
*
* <para>igraph attributes are designed to be flexible and extensible.
* In igraph attributes are implemented via an interface abstraction:
* any type implementing the functions in the interface, can be used
* for storing vertex, edge and graph attributes. This means that
* different attribute implementations can be used together with
* igraph. This is reasonable: if igraph is used from Python attributes can be
* of any Python type, from GNU R all R types are allowed. There is an
* experimental attribute implementation to be used when programming
* in C, but by default it is currently turned off.</para>
*
* <para>First we briefly look over how attribute handlers can be
* implemented. This is not something a user does every day. It is
* rather typically the job of the high level interface writers. (But
* it is possible to write an interface without implementing
* attributes.) Then we show the experimental C attribute handler.</para>
*/
/**
* \section about_attribute_table
* <para>It is possible to attach an attribute handling
* interface to \a igraph. This is simply a table of functions, of
* type \ref igraph_attribute_table_t. These functions are invoked to
* notify the attribute handling code about the structural changes in
* a graph. See the documentation of this type for details.</para>
*
* <para>By default there is no attribute interface attached to \a igraph,
* to attach one, call \ref igraph_set_attribute_table with your new
* table. </para>
*
*/
/**
* \section about_attribute_combination
*
* <para>Several graph operations may collapse multiple vertices or edges into
* a single one. Attribute combination lists are used to indicate to the attribute
* handler how to combine the attributes of the original vertices or edges and
* how to derive the final attribute value that is to be assigned to the collapsed
* vertex or edge. For example, \ref igraph_simplify() removes loops and combines
* multiple edges into a single one; in case of a graph with an edge attribute
* named \c weight the attribute combination list can tell the attribute handler
* whether the weight of a collapsed edge should be the sum, the mean or some other
* function of the weights of the original edges that were collapsed into one.</para>
*
* <para>One attribute combination list may contain several attribute combination
* records, one for each vertex or edge attribute that is to be handled during the
* operation.</para>
*/
/**
* \typedef igraph_attribute_type_t
* The possible types of the attributes.
*
* Note that this is only the
* type communicated by the attribute interface towards igraph
* functions. E.g. in the R attribute handler, it is safe to say
* that all complex R object attributes are strings, as long as this
* interface is able to serialize them into strings. See also \ref
* igraph_attribute_table_t.
* \enumval IGRAPH_ATTRIBUTE_UNSPECIFIED Currently used internally
* as a "null value" or "placeholder value" in some algorithms.
* Attribute records with this type must not be passed to igraph
* functions.
* \enumval IGRAPH_ATTRIBUTE_NUMERIC Numeric attribute.
* \enumval IGRAPH_ATTRIBUTE_BOOLEAN Logical values, true or false.
* \enumval IGRAPH_ATTRIBUTE_STRING Attribute that can be converted to
* a string.
* \enumval IGRAPH_ATTRIBUTE_OBJECT Custom attribute type, to be
* used for special data types by client applications. The R and
* Python interfaces use this for attributes that hold R or Python
* objects. Usually ignored by igraph functions.
*/
typedef enum { IGRAPH_ATTRIBUTE_UNSPECIFIED = 0,
IGRAPH_ATTRIBUTE_DEFAULT IGRAPH_DEPRECATED_ENUMVAL = IGRAPH_ATTRIBUTE_UNSPECIFIED,
IGRAPH_ATTRIBUTE_NUMERIC = 1,
IGRAPH_ATTRIBUTE_BOOLEAN = 2,
IGRAPH_ATTRIBUTE_STRING = 3,
IGRAPH_ATTRIBUTE_OBJECT = 127
} igraph_attribute_type_t;
typedef struct igraph_attribute_record_t {
const char *name;
igraph_attribute_type_t type;
const void *value;
} igraph_attribute_record_t;
typedef enum { IGRAPH_ATTRIBUTE_GRAPH = 0,
IGRAPH_ATTRIBUTE_VERTEX,
IGRAPH_ATTRIBUTE_EDGE
} igraph_attribute_elemtype_t;
/**
* \typedef igraph_attribute_combination_type_t
* The possible types of attribute combinations.
*
* \enumval IGRAPH_ATTRIBUTE_COMBINE_IGNORE Ignore old attributes, use an empty value.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_DEFAULT Use the default way to combine attributes (decided by the attribute handler implementation).
* \enumval IGRAPH_ATTRIBUTE_COMBINE_FUNCTION Supply your own function to combine
* attributes.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_SUM Take the sum of the attributes.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_PROD Take the product of the attributes.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_MIN Take the minimum attribute.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_MAX Take the maximum attribute.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_RANDOM Take a random attribute.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_FIRST Take the first attribute.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_LAST Take the last attribute.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_MEAN Take the mean of the attributes.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_MEDIAN Take the median of the attributes.
* \enumval IGRAPH_ATTRIBUTE_COMBINE_CONCAT Concatenate the attributes.
*/
typedef enum {
IGRAPH_ATTRIBUTE_COMBINE_IGNORE = 0,
IGRAPH_ATTRIBUTE_COMBINE_DEFAULT = 1,
IGRAPH_ATTRIBUTE_COMBINE_FUNCTION = 2,
IGRAPH_ATTRIBUTE_COMBINE_SUM = 3,
IGRAPH_ATTRIBUTE_COMBINE_PROD = 4,
IGRAPH_ATTRIBUTE_COMBINE_MIN = 5,
IGRAPH_ATTRIBUTE_COMBINE_MAX = 6,
IGRAPH_ATTRIBUTE_COMBINE_RANDOM = 7,
IGRAPH_ATTRIBUTE_COMBINE_FIRST = 8,
IGRAPH_ATTRIBUTE_COMBINE_LAST = 9,
IGRAPH_ATTRIBUTE_COMBINE_MEAN = 10,
IGRAPH_ATTRIBUTE_COMBINE_MEDIAN = 11,
IGRAPH_ATTRIBUTE_COMBINE_CONCAT = 12
} igraph_attribute_combination_type_t;
typedef void (*igraph_function_pointer_t)(void);
typedef struct igraph_attribute_combination_record_t {
const char *name; /* can be NULL, meaning: the rest */
igraph_attribute_combination_type_t type;
igraph_function_pointer_t func;
} igraph_attribute_combination_record_t;
typedef struct igraph_attribute_combination_t {
igraph_vector_ptr_t list;
} igraph_attribute_combination_t;
#define IGRAPH_NO_MORE_ATTRIBUTES ((const char*)0)
IGRAPH_EXPORT igraph_error_t igraph_attribute_combination_init(igraph_attribute_combination_t *comb);
IGRAPH_EXPORT igraph_error_t igraph_attribute_combination(igraph_attribute_combination_t *comb, ...);
IGRAPH_EXPORT void igraph_attribute_combination_destroy(igraph_attribute_combination_t *comb);
IGRAPH_EXPORT igraph_error_t igraph_attribute_combination_add(igraph_attribute_combination_t *comb,
const char *name,
igraph_attribute_combination_type_t type,
igraph_function_pointer_t func);
IGRAPH_EXPORT igraph_error_t igraph_attribute_combination_remove(igraph_attribute_combination_t *comb,
const char *name);
IGRAPH_EXPORT igraph_error_t igraph_attribute_combination_query(const igraph_attribute_combination_t *comb,
const char *name,
igraph_attribute_combination_type_t *type,
igraph_function_pointer_t *func);
/**
* \struct igraph_attribute_table_t
* \brief Table of functions to perform operations on attributes
*
* This type collects the functions defining an attribute handler.
* It has the following members:
* \member init This function is called whenever a new graph object is
* created, right after it is created but before any vertices or
* edges are added. It is supposed to set the \c attr member of the \c
* igraph_t object. It is expected to return an error code.
* \member destroy This function is called whenever the graph object
* is destroyed, right before freeing the allocated memory.
* \member copy This function is called when copying a graph with \ref
* igraph_copy, after the structure of the graph has been already
* copied. It is expected to return an error code.
* \member add_vertices Called when vertices are added to a
* graph, before adding the vertices themselves.
* The number of vertices to add is supplied as an
* argument. Expected to return an error code.
* \member permute_vertices Typically called when a new graph is
* created based on an existing one, e.g. if vertices are removed
* from a graph. The supplied index vector defines which old vertex
* a new vertex corresponds to. Its length must be the same as the
* number of vertices in the new graph.
* \member combine_vertices This function is called when the creation
* of a new graph involves a merge (contraction, etc.) of vertices
* from another graph. The function is after the new graph was created.
* An argument specifies how several vertices from the old graph map to a
* single vertex in the new graph.
* \member add_edges Called when new edges have been added. The number
* of new edges are supplied as well. It is expected to return an
* error code.
* \member permute_edges Typically called when a new graph is created and
* some of the new edges should carry the attributes of some of the
* old edges. The idx vector shows the mapping between the old edges and
* the new ones. Its length is the same as the number of edges in the new
* graph, and for each edge it gives the id of the old edge (the edge in
* the old graph).
* \member combine_edges This function is called when the creation
* of a new graph involves a merge (contraction, etc.) of edges
* from another graph. The function is after the new graph was created.
* An argument specifies how several edges from the old graph map to a
* single edge in the new graph.
* \member get_info Query the attributes of a graph, the names and
* types should be returned.
* \member has_attr Check whether a graph has the named
* graph/vertex/edge attribute.
* \member gettype Query the type of a graph/vertex/edge attribute.
* \member get_numeric_graph_attr Query a numeric graph attribute. The
* value should be placed as the first element of the \p value
* vector.
* \member get_string_graph_attr Query a string graph attribute. The
* value should be placed as the first element of the \p value
* string vector.
* \member get_bool_graph_attr Query a boolean graph attribute. The
* value should be placed as the first element of the \p value
* boolean vector.
* \member get_numeric_vertex_attr Query a numeric vertex attribute,
* for the vertices included in \p vs.
* \member get_string_vertex_attr Query a string vertex attribute,
* for the vertices included in \p vs.
* \member get_bool_vertex_attr Query a boolean vertex attribute,
* for the vertices included in \p vs.
* \member get_numeric_edge_attr Query a numeric edge attribute, for
* the edges included in \p es.
* \member get_string_edge_attr Query a string edge attribute, for the
* edges included in \p es.
* \member get_bool_edge_attr Query a boolean edge attribute, for the
* edges included in \p es.
*
* Note that the <function>get_*_*_attr</function> are allowed to
* convert the attributes to numeric or string. E.g. if a vertex attribute
* is a GNU R complex data type, then
* <function>get_string_vertex_attribute</function> may serialize it
* into a string, but this probably makes sense only if
* <function>add_vertices</function> is able to deserialize it.
*/
typedef struct igraph_attribute_table_t {
igraph_error_t (*init)(igraph_t *graph, igraph_vector_ptr_t *attr);
void (*destroy)(igraph_t *graph);
igraph_error_t (*copy)(igraph_t *to, const igraph_t *from, igraph_bool_t ga,
igraph_bool_t va, igraph_bool_t ea);
igraph_error_t (*add_vertices)(igraph_t *graph, igraph_integer_t nv, igraph_vector_ptr_t *attr);
igraph_error_t (*permute_vertices)(const igraph_t *graph,
igraph_t *newgraph,
const igraph_vector_int_t *idx);
igraph_error_t (*combine_vertices)(const igraph_t *graph,
igraph_t *newgraph,
const igraph_vector_int_list_t *merges,
const igraph_attribute_combination_t *comb);
igraph_error_t (*add_edges)(igraph_t *graph, const igraph_vector_int_t *edges,
igraph_vector_ptr_t *attr);
igraph_error_t (*permute_edges)(const igraph_t *graph,
igraph_t *newgraph, const igraph_vector_int_t *idx);
igraph_error_t (*combine_edges)(const igraph_t *graph,
igraph_t *newgraph,
const igraph_vector_int_list_t *merges,
const igraph_attribute_combination_t *comb);
igraph_error_t (*get_info)(const igraph_t *graph,
igraph_strvector_t *gnames, igraph_vector_int_t *gtypes,
igraph_strvector_t *vnames, igraph_vector_int_t *vtypes,
igraph_strvector_t *enames, igraph_vector_int_t *etypes);
igraph_bool_t (*has_attr)(const igraph_t *graph, igraph_attribute_elemtype_t type,
const char *name);
igraph_error_t (*gettype)(const igraph_t *graph, igraph_attribute_type_t *type,
igraph_attribute_elemtype_t elemtype, const char *name);
igraph_error_t (*get_numeric_graph_attr)(const igraph_t *graph, const char *name,
igraph_vector_t *value);
igraph_error_t (*get_string_graph_attr)(const igraph_t *graph, const char *name,
igraph_strvector_t *value);
igraph_error_t (*get_bool_graph_attr)(const igraph_t *igraph, const char *name,
igraph_vector_bool_t *value);
igraph_error_t (*get_numeric_vertex_attr)(const igraph_t *graph, const char *name,
igraph_vs_t vs,
igraph_vector_t *value);
igraph_error_t (*get_string_vertex_attr)(const igraph_t *graph, const char *name,
igraph_vs_t vs,
igraph_strvector_t *value);
igraph_error_t (*get_bool_vertex_attr)(const igraph_t *graph, const char *name,
igraph_vs_t vs,
igraph_vector_bool_t *value);
igraph_error_t (*get_numeric_edge_attr)(const igraph_t *graph, const char *name,
igraph_es_t es,
igraph_vector_t *value);
igraph_error_t (*get_string_edge_attr)(const igraph_t *graph, const char *name,
igraph_es_t es,
igraph_strvector_t *value);
igraph_error_t (*get_bool_edge_attr)(const igraph_t *graph, const char *name,
igraph_es_t es,
igraph_vector_bool_t *value);
} igraph_attribute_table_t;
IGRAPH_EXPORT IGRAPH_DEPRECATED igraph_attribute_table_t * igraph_i_set_attribute_table(const igraph_attribute_table_t * table);
IGRAPH_EXPORT igraph_attribute_table_t * igraph_set_attribute_table(const igraph_attribute_table_t * table);
IGRAPH_EXPORT igraph_bool_t igraph_has_attribute_table(void);
/* Experimental attribute handler in C */
IGRAPH_EXPORT extern const igraph_attribute_table_t igraph_cattribute_table;
IGRAPH_EXPORT igraph_real_t igraph_cattribute_GAN(const igraph_t *graph, const char *name);
IGRAPH_EXPORT igraph_bool_t igraph_cattribute_GAB(const igraph_t *graph, const char *name);
IGRAPH_EXPORT const char* igraph_cattribute_GAS(const igraph_t *graph, const char *name);
IGRAPH_EXPORT igraph_real_t igraph_cattribute_VAN(const igraph_t *graph, const char *name,
igraph_integer_t vid);
IGRAPH_EXPORT igraph_bool_t igraph_cattribute_VAB(const igraph_t *graph, const char *name,
igraph_integer_t vid);
IGRAPH_EXPORT const char* igraph_cattribute_VAS(const igraph_t *graph, const char *name,
igraph_integer_t vid);
IGRAPH_EXPORT igraph_real_t igraph_cattribute_EAN(const igraph_t *graph, const char *name,
igraph_integer_t eid);
IGRAPH_EXPORT igraph_bool_t igraph_cattribute_EAB(const igraph_t *graph, const char *name,
igraph_integer_t eid);
IGRAPH_EXPORT const char* igraph_cattribute_EAS(const igraph_t *graph, const char *name,
igraph_integer_t eid);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VANV(const igraph_t *graph, const char *name,
igraph_vs_t vids, igraph_vector_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EANV(const igraph_t *graph, const char *name,
igraph_es_t eids, igraph_vector_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VASV(const igraph_t *graph, const char *name,
igraph_vs_t vids, igraph_strvector_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EASV(const igraph_t *graph, const char *name,
igraph_es_t eids, igraph_strvector_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VABV(const igraph_t *graph, const char *name,
igraph_vs_t vids, igraph_vector_bool_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EABV(const igraph_t *graph, const char *name,
igraph_es_t eids, igraph_vector_bool_t *result);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_list(const igraph_t *graph,
igraph_strvector_t *gnames, igraph_vector_int_t *gtypes,
igraph_strvector_t *vnames, igraph_vector_int_t *vtypes,
igraph_strvector_t *enames, igraph_vector_int_t *etypes);
IGRAPH_EXPORT igraph_bool_t igraph_cattribute_has_attr(const igraph_t *graph,
igraph_attribute_elemtype_t type,
const char *name);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_GAN_set(igraph_t *graph, const char *name,
igraph_real_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_GAB_set(igraph_t *graph, const char *name,
igraph_bool_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_GAS_set(igraph_t *graph, const char *name,
const char *value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAN_set(igraph_t *graph, const char *name,
igraph_integer_t vid, igraph_real_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAB_set(igraph_t *graph, const char *name,
igraph_integer_t vid, igraph_bool_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAS_set(igraph_t *graph, const char *name,
igraph_integer_t vid, const char *value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAN_set(igraph_t *graph, const char *name,
igraph_integer_t eid, igraph_real_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAB_set(igraph_t *graph, const char *name,
igraph_integer_t eid, igraph_bool_t value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAS_set(igraph_t *graph, const char *name,
igraph_integer_t eid, const char *value);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAN_setv(igraph_t *graph, const char *name,
const igraph_vector_t *v);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAB_setv(igraph_t *graph, const char *name,
const igraph_vector_bool_t *v);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_VAS_setv(igraph_t *graph, const char *name,
const igraph_strvector_t *sv);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAN_setv(igraph_t *graph, const char *name,
const igraph_vector_t *v);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAB_setv(igraph_t *graph, const char *name,
const igraph_vector_bool_t *v);
IGRAPH_EXPORT igraph_error_t igraph_cattribute_EAS_setv(igraph_t *graph, const char *name,
const igraph_strvector_t *sv);
IGRAPH_EXPORT void igraph_cattribute_remove_g(igraph_t *graph, const char *name);
IGRAPH_EXPORT void igraph_cattribute_remove_v(igraph_t *graph, const char *name);
IGRAPH_EXPORT void igraph_cattribute_remove_e(igraph_t *graph, const char *name);
IGRAPH_EXPORT void igraph_cattribute_remove_all(igraph_t *graph, igraph_bool_t g,
igraph_bool_t v, igraph_bool_t e);
/**
* \define GAN
* Query a numeric graph attribute.
*
* This is shorthand for \ref igraph_cattribute_GAN().
* \param graph The graph.
* \param n The name of the attribute.
* \return The value of the attribute.
*/
#define GAN(graph,n) (igraph_cattribute_GAN((graph), (n)))
/**
* \define GAB
* Query a boolean graph attribute.
*
* This is shorthand for \ref igraph_cattribute_GAB().
* \param graph The graph.
* \param n The name of the attribute.
* \return The value of the attribute.
*/
#define GAB(graph,n) (igraph_cattribute_GAB((graph), (n)))
/**
* \define GAS
* Query a string graph attribute.
*
* This is shorthand for \ref igraph_cattribute_GAS().
* \param graph The graph.
* \param n The name of the attribute.
* \return The value of the attribute.
*/
#define GAS(graph,n) (igraph_cattribute_GAS((graph), (n)))
/**
* \define VAN
* Query a numeric vertex attribute.
*
* This is shorthand for \ref igraph_cattribute_VAN().
* \param graph The graph.
* \param n The name of the attribute.
* \param v The id of the vertex.
* \return The value of the attribute.
*/
#define VAN(graph,n,v) (igraph_cattribute_VAN((graph), (n), (v)))
/**
* \define VAB
* Query a boolean vertex attribute.
*
* This is shorthand for \ref igraph_cattribute_VAB().
* \param graph The graph.
* \param n The name of the attribute.
* \param v The id of the vertex.
* \return The value of the attribute.
*/
#define VAB(graph,n,v) (igraph_cattribute_VAB((graph), (n), (v)))
/**
* \define VAS
* Query a string vertex attribute.
*
* This is shorthand for \ref igraph_cattribute_VAS().
* \param graph The graph.
* \param n The name of the attribute.
* \param v The id of the vertex.
* \return The value of the attribute.
*/
#define VAS(graph,n,v) (igraph_cattribute_VAS((graph), (n), (v)))
/**
* \define VANV
* Query a numeric vertex attribute for all vertices.
*
* This is a shorthand for \ref igraph_cattribute_VANV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define VANV(graph,n,vec) (igraph_cattribute_VANV((graph),(n), \
igraph_vss_all(), (vec)))
/**
* \define VABV
* Query a boolean vertex attribute for all vertices.
*
* This is a shorthand for \ref igraph_cattribute_VABV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized boolean vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define VABV(graph,n,vec) (igraph_cattribute_VABV((graph),(n), \
igraph_vss_all(), (vec)))
/**
* \define VASV
* Query a string vertex attribute for all vertices.
*
* This is a shorthand for \ref igraph_cattribute_VASV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized string vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define VASV(graph,n,vec) (igraph_cattribute_VASV((graph),(n), \
igraph_vss_all(), (vec)))
/**
* \define EAN
* Query a numeric edge attribute.
*
* This is shorthand for \ref igraph_cattribute_EAN().
* \param graph The graph.
* \param n The name of the attribute.
* \param e The id of the edge.
* \return The value of the attribute.
*/
#define EAN(graph,n,e) (igraph_cattribute_EAN((graph), (n), (e)))
/**
* \define EAB
* Query a boolean edge attribute.
*
* This is shorthand for \ref igraph_cattribute_EAB().
* \param graph The graph.
* \param n The name of the attribute.
* \param e The id of the edge.
* \return The value of the attribute.
*/
#define EAB(graph,n,e) (igraph_cattribute_EAB((graph), (n), (e)))
/**
* \define EAS
* Query a string edge attribute.
*
* This is shorthand for \ref igraph_cattribute_EAS().
* \param graph The graph.
* \param n The name of the attribute.
* \param e The id of the edge.
* \return The value of the attribute.
*/
#define EAS(graph,n,e) (igraph_cattribute_EAS((graph), (n), (e)))
/**
* \define EANV
* Query a numeric edge attribute for all edges.
*
* This is a shorthand for \ref igraph_cattribute_EANV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define EANV(graph,n,vec) (igraph_cattribute_EANV((graph),(n), \
igraph_ess_all(IGRAPH_EDGEORDER_ID), (vec)))
/**
* \define EABV
* Query a boolean edge attribute for all edges.
*
* This is a shorthand for \ref igraph_cattribute_EABV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define EABV(graph,n,vec) (igraph_cattribute_EABV((graph),(n), \
igraph_ess_all(IGRAPH_EDGEORDER_ID), (vec)))
/**
* \define EASV
* Query a string edge attribute for all edges.
*
* This is a shorthand for \ref igraph_cattribute_EASV().
* \param graph The graph.
* \param n The name of the attribute.
* \param vec Pointer to an initialized string vector, the result is
* stored here. It will be resized, if needed.
* \return Error code.
*/
#define EASV(graph,n,vec) (igraph_cattribute_EASV((graph),(n), \
igraph_ess_all(IGRAPH_EDGEORDER_ID), (vec)))
/**
* \define SETGAN
* Set a numeric graph attribute
*
* This is a shorthand for \ref igraph_cattribute_GAN_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETGAN(graph,n,value) (igraph_cattribute_GAN_set((graph),(n),(value)))
/**
* \define SETGAB
* Set a boolean graph attribute
*
* This is a shorthand for \ref igraph_cattribute_GAB_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETGAB(graph,n,value) (igraph_cattribute_GAB_set((graph),(n),(value)))
/**
* \define SETGAS
* Set a string graph attribute
*
* This is a shorthand for \ref igraph_cattribute_GAS_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETGAS(graph,n,value) (igraph_cattribute_GAS_set((graph),(n),(value)))
/**
* \define SETVAN
* Set a numeric vertex attribute
*
* This is a shorthand for \ref igraph_cattribute_VAN_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param vid Ids of the vertices to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETVAN(graph,n,vid,value) (igraph_cattribute_VAN_set((graph),(n),(vid),(value)))
/**
* \define SETVAB
* Set a boolean vertex attribute
*
* This is a shorthand for \ref igraph_cattribute_VAB_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param vid Ids of the vertices to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETVAB(graph,n,vid,value) (igraph_cattribute_VAB_set((graph),(n),(vid),(value)))
/**
* \define SETVAS
* Set a string vertex attribute
*
* This is a shorthand for \ref igraph_cattribute_VAS_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param vid Ids of the vertices to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETVAS(graph,n,vid,value) (igraph_cattribute_VAS_set((graph),(n),(vid),(value)))
/**
* \define SETEAN
* Set a numeric edge attribute
*
* This is a shorthand for \ref igraph_cattribute_EAN_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param eid Ids of the edges to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETEAN(graph,n,eid,value) (igraph_cattribute_EAN_set((graph),(n),(eid),(value)))
/**
* \define SETEAB
* Set a boolean edge attribute
*
* This is a shorthand for \ref igraph_cattribute_EAB_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param eid Ids of the edges to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETEAB(graph,n,eid,value) (igraph_cattribute_EAB_set((graph),(n),(eid),(value)))
/**
* \define SETEAS
* Set a string edge attribute
*
* This is a shorthand for \ref igraph_cattribute_EAS_set().
* \param graph The graph.
* \param n The name of the attribute.
* \param eid Ids of the edges to set.
* \param value The new value of the attribute.
* \return Error code.
*/
#define SETEAS(graph,n,eid,value) (igraph_cattribute_EAS_set((graph),(n),(eid),(value)))
/**
* \define SETVANV
* Set a numeric vertex attribute for all vertices
*
* This is a shorthand for \ref igraph_cattribute_VAN_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
* \return Error code.
*/
#define SETVANV(graph,n,v) (igraph_cattribute_VAN_setv((graph),(n),(v)))
/**
* \define SETVABV
* Set a boolean vertex attribute for all vertices
*
* This is a shorthand for \ref igraph_cattribute_VAB_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
* \return Error code.
*/
#define SETVABV(graph,n,v) (igraph_cattribute_VAB_setv((graph),(n),(v)))
/**
* \define SETVASV
* Set a string vertex attribute for all vertices
*
* This is a shorthand for \ref igraph_cattribute_VAS_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
* \return Error code.
*/
#define SETVASV(graph,n,v) (igraph_cattribute_VAS_setv((graph),(n),(v)))
/**
* \define SETEANV
* Set a numeric edge attribute for all edges
*
* This is a shorthand for \ref igraph_cattribute_EAN_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
*/
#define SETEANV(graph,n,v) (igraph_cattribute_EAN_setv((graph),(n),(v)))
/**
* \define SETEABV
* Set a boolean edge attribute for all edges
*
* This is a shorthand for \ref igraph_cattribute_EAB_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
*/
#define SETEABV(graph,n,v) (igraph_cattribute_EAB_setv((graph),(n),(v)))
/**
* \define SETEASV
* Set a string edge attribute for all edges
*
* This is a shorthand for \ref igraph_cattribute_EAS_setv().
* \param graph The graph.
* \param n The name of the attribute.
* \param v Vector containing the new values of the attributes.
*/
#define SETEASV(graph,n,v) (igraph_cattribute_EAS_setv((graph),(n),(v)))
/**
* \define DELGA
* Remove a graph attribute.
*
* A shorthand for \ref igraph_cattribute_remove_g().
* \param graph The graph.
* \param n The name of the attribute to remove.
*/
#define DELGA(graph,n) (igraph_cattribute_remove_g((graph),(n)))
/**
* \define DELVA
* Remove a vertex attribute.
*
* A shorthand for \ref igraph_cattribute_remove_v().
* \param graph The graph.
* \param n The name of the attribute to remove.
*/
#define DELVA(graph,n) (igraph_cattribute_remove_v((graph),(n)))
/**
* \define DELEA
* Remove an edge attribute.
*
* A shorthand for \ref igraph_cattribute_remove_e().
* \param graph The graph.
* \param n The name of the attribute to remove.
*/
#define DELEA(graph,n) (igraph_cattribute_remove_e((graph),(n)))
/**
* \define DELGAS
* Remove all graph attributes.
*
* Calls \ref igraph_cattribute_remove_all().
* \param graph The graph.
*/
#define DELGAS(graph) (igraph_cattribute_remove_all((graph),1,0,0))
/**
* \define DELVAS
* Remove all vertex attributes.
*
* Calls \ref igraph_cattribute_remove_all().
* \param graph The graph.
*/
#define DELVAS(graph) (igraph_cattribute_remove_all((graph),0,1,0))
/**
* \define DELEAS
* Remove all edge attributes.
*
* Calls \ref igraph_cattribute_remove_all().
* \param graph The graph.
*/
#define DELEAS(graph) (igraph_cattribute_remove_all((graph),0,0,1))
/**
* \define DELALL
* Remove all attributes.
*
* All graph, vertex and edges attributes will be removed.
* Calls \ref igraph_cattribute_remove_all().
* \param graph The graph.
*/
#define DELALL(graph) (igraph_cattribute_remove_all((graph),1,1,1))
__END_DECLS
#endif
|