Class

NumCosmoHaloCatalog

Description [src]

final class NumCosmo.HaloCatalog : NumCosmoMath.Catalog
{
  /* No available fields */
}

Catalog of halos, clusters or member objects.

A thin specialization of NcmCatalog that tags its rows with a logical NcHaloCatalogKind (halo, cluster or member) and knows which of its columns hold the row id and the parent id. The data itself is stored in the generic NcmCatalog backend; this class only adds the schema metadata and convenience accessors to follow the id/parent-id linkage between related catalogs (for example clusters pointing back to their halos, or members to their host).

It does not generate or sample anything: it is a container assembled by higher-level code from the existing sampling machinery.

Ancestors

Constructors

nc_halo_catalog_new

Creates a new NcHaloCatalog with nrows rows and the columns named by col_names, all values initialized to zero. id_col and parent_id_col, when given, name the columns used to follow the linkage between catalogs.

Functions

nc_halo_catalog_clear

If hcat is different from NULL, decreases its reference count and sets hcat to NULL.

Instance methods

nc_halo_catalog_find_children

Finds the rows whose parent id equals parent_id, using the configured parent id column.

nc_halo_catalog_free

Decreases the reference count of hcat by one.

nc_halo_catalog_get_id

Gets the id of row i, read from the configured id column.

nc_halo_catalog_get_kind

Gets the kind of objects stored in hcat.

nc_halo_catalog_get_parent_id

Gets the parent id of row i, read from the configured parent id column.

nc_halo_catalog_peek_id_col

Gets the name of the id column.

nc_halo_catalog_peek_parent_id_col

Gets the name of the parent id column.

nc_halo_catalog_ref

Increases the reference count of hcat by one.

Methods inherited from NcmCatalog (15)

ncm_catalog_free

Decreases the reference count of catalog by one.

ncm_catalog_get

Gets the value at row i and column col.

ncm_catalog_get_bool

Gets the boolean value at row i and column col.

ncm_catalog_get_col_type

Gets the logical type of the column named col.

ncm_catalog_get_index

Gets the column index from the column name.

ncm_catalog_get_int

Gets the integer value at row i and column col.

ncm_catalog_has_column

Checks whether catalog has a column named col.

ncm_catalog_len

Gets the number of rows (entries) in the catalog.

ncm_catalog_ncols

Gets the number of columns in the catalog.

ncm_catalog_peek_columns

Gets the catalog column names.

ncm_catalog_peek_data

Gets the catalog data matrix.

ncm_catalog_ref

Increases the reference count of catalog by one.

ncm_catalog_set

Sets the value at row i and column col.

ncm_catalog_set_bool

Sets the boolean value at row i and column col, stored as 0.0/1.0 in the double backing matrix.

ncm_catalog_set_int

Sets the integer value at row i and column col. The value is stored in the double backing matrix (lossless for magnitudes below 2^53).

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

NumCosmo.HaloCatalog:id-col

Name of the column holding each row’s own id, or NULL when the catalog has no id column.

NumCosmo.HaloCatalog:kind

The kind of objects stored in the catalog.

NumCosmo.HaloCatalog:parent-id-col

Name of the column holding each row’s parent id, or NULL when the catalog has no parent linkage (for example a top-level halo catalog).

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct NumCosmoHaloCatalogClass {
  NcmCatalogClass parent_class;
  
}

No description available.

Class members

parent_class: NcmCatalogClass: No description available.