A multidimensional array of identical data types. More...
#include <Array.h>
Classes | |
| struct | dimension |
| struct | var_chunk_info_t |
| struct | var_storage_info |
Public Types | |
| typedef std::vector< dimension >::const_iterator | Dim_citer |
| typedef std::vector< dimension >::iterator | Dim_iter |
Public Member Functions | |
| virtual void | add_constraint (Dim_iter i, D4Dimension *dim) |
| virtual void | add_constraint (Dim_iter i, int start, int stride, int stop) |
| Adds a constraint to an Array dimension. | |
| virtual void | add_constraint_ll (Dim_iter i, int64_t start, int64_t stride, int64_t stop) |
| void | add_var (BaseType *v, Part p=nil) override |
| Add the BaseType pointer to this constructor type instance. | |
| void | add_var_nocopy (BaseType *v, Part p=nil) override |
| void | append_dim (D4Dimension *dim) |
| void | append_dim (int size, const string &name="") |
| Add a dimension of a given size. | |
| void | append_dim_ll (int64_t size, const string &name="") |
| Array (const Array &rhs) | |
| The Array copy constructor. | |
| Array (const string &n, BaseType *v, bool is_dap4=false) | |
| Array constructor. | |
| Array (const string &n, const string &d, BaseType *v, bool is_dap4=false) | |
| Array constructor. | |
| bool | check_semantics (string &msg, bool all=false) override |
| Check semantic features of the Array. | |
| void | clear_all_dims () |
| virtual void | clear_constraint () |
| Clears the projection; add each projected dimension explicitly using add_constraint. | |
| Dim_iter | dim_begin () |
| Dim_iter | dim_end () |
| virtual D4Dimension * | dimension_D4dim (Dim_iter i) |
| virtual string | dimension_name (Dim_iter i) |
| Returns the name of the specified dimension. | |
| virtual int | dimension_size (Dim_iter i, bool constrained=false) |
| Returns the size of the dimension. | |
| virtual int64_t | dimension_size_ll (Dim_iter i, bool constrained=false) |
| virtual int | dimension_start (Dim_iter i, bool constrained=false) |
| Return the start index of a dimension. | |
| virtual int64_t | dimension_start_ll (Dim_iter i, bool constrained=false) |
| virtual int | dimension_stop (Dim_iter i, bool constrained=false) |
| Return the stop index of the constraint. | |
| virtual int64_t | dimension_stop_ll (Dim_iter i, bool constrained=false) |
| virtual int | dimension_stride (Dim_iter i, bool constrained=false) |
| Returns the stride value of the constraint. | |
| virtual int64_t | dimension_stride_ll (Dim_iter i, bool constrained=false) |
| virtual unsigned int | dimensions (bool constrained=false) |
| Return the total number of dimensions in the array. | |
| void | dump (ostream &strm) const override |
| dumps information about this object | |
| bool | get_dio_flag () const |
| var_storage_info & | get_var_storage_info () |
| bool | is_dap2_grid () |
| bool | is_dap4_projected (std::vector< std::string > &projected_dap4_inventory) override |
| virtual D4Maps * | maps () |
| Array & | operator= (const Array &rhs) |
| void | prepend_dim (D4Dimension *dim) |
| void | prepend_dim (int size, const string &name="") |
| virtual void | print_as_map_xml (FILE *out, string space=" ", bool constrained=false) |
| virtual void | print_as_map_xml (ostream &out, string space=" ", bool constrained=false) |
| virtual void | print_as_map_xml_writer (XMLWriter &xml, bool constrained) |
| void | print_dap4 (XMLWriter &xml, bool constrained=false) override |
| Print the DAP4 representation of an array. | |
| void | print_decl (FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) override |
| void | print_decl (ostream &out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false) override |
| void | print_val (FILE *out, string space="", bool print_decl_p=true) override |
| void | print_val (ostream &out, string space="", bool print_decl_p=true) override |
| void | print_xml (FILE *out, string space=" ", bool constrained=false) override |
| Prints a DDS entry for the Array. | |
| void | print_xml (ostream &out, string space=" ", bool constrained=false) override |
| virtual void | print_xml_core (FILE *out, string space, bool constrained, string tag) |
| virtual void | print_xml_core (ostream &out, string space, bool constrained, string tag) |
| void | print_xml_writer (XMLWriter &xml, bool constrained=false) override |
| virtual void | print_xml_writer_core (XMLWriter &out, bool constrained, string tag) |
| BaseType * | ptr_duplicate () override |
| void | rename_dim (const string &oldName="", const string &newName="") |
| Renames dimension. | |
| virtual void | reset_constraint () |
| Reset constraint to select entire array. | |
| void | set_dio_flag (bool dio_flag_value=true) |
| void | set_var_storage_info (const var_storage_info &my_vs_info) |
| Set the variable storage information for direct IO optimization. | |
| std::vector< BaseType * > * | transform_to_dap2 (AttrTable *parent_attr_table) override |
| Transforms this instance of a D4Array into the corresponding DAP2 object. | |
| void | transform_to_dap4 (D4Group *root, Constructor *container) override |
| virtual void | update_length (int size=0) |
| virtual void | update_length_ll (unsigned long long size=0) |
| virtual | ~Array () |
| The Array destructor. | |
Protected Member Functions | |
| void | _duplicate (const Array &a) |
| uint64_t | print_array (FILE *out, uint64_t index, unsigned int dims, uint64_t shape[]) |
| Print the value given the current constraint. | |
| uint64_t | print_array (ostream &out, uint64_t index, unsigned int dims, uint64_t shape[]) |
| Print the value given the current constraint. | |
| std::vector< dimension > & | shape () |
Friends | |
| class | ArrayTest |
| class | D4Group |
Detailed Description
A multidimensional array of identical data types.
This class is used to hold arrays of data. The elements of the array can be simple or compound data types. There is no limit on the number of dimensions an array can have, or on the size of each dimension.
If desired, the user can give each dimension of an array a name. You can, for example, have a 360x180 array of temperatures, covering the whole globe with one-degree squares. In this case, you could name the first dimension Longitude and the second dimension Latitude. This can help prevent a great deal of confusion.
The Array is used as part of the Grid class, where the dimension names are crucial to its structure. The dimension names correspond to Map vectors, holding the actual values for that column of the array.
In DAP4, the Array may be a Coverage or a simple Array. In the former case the Array will have both named dimensions and maps, where the maps (instances of D4Map) are what make the Array a Coverage. Coverages are a generalization of DAP2 Grids.
Each array dimension carries with it its own projection information. The projection information takes the form of three integers: the start, stop, and stride values. This is clearest with an example. Consider a one-dimensional array 10 elements long. If the start value of the dimension constraint is 3, then the constrained array appears to be seven elements long. If the stop value is changed to 7, then the array appears to be five elements long. If the stride is changed to two, the array will appear to be 3 elements long. Array constraints are written as: [start:stride:stop].
A = [1 2 3 4 5 6 7 8 9 10] A[3::] = [4 5 6 7 8 9 10] A[3::7] = [4 5 6 7 8] A[3:2:7] = [4 6 8] A[0:3:9] = [1 4 7 10]
- Note
- Arrays use zero-based indexing.
- This class is used for both DAP2 and DAP4.
- An interesting 'feature' of the DAP4 Array is that its Maps are added after construction. None of the Array constructors build the Maps, but the copy ctor is supposed to copy it correctly. The original design has pointers for the parent and the source of the Map's value, but the actual 'parent' array is the object being constructed, so it does not exist! I have thus replaced the pointers with paths. Use the dataset's root group find_var() method to get the objects. The root group can be found using the new BaseType::get_ancestor() method. jhrg 9/16/22
Member Typedef Documentation
◆ Dim_citer
| typedef std::vector<dimension>::const_iterator libdap::Array::Dim_citer |
A constant iterator used to access the various dimensions of an Array.
- See also
- dim_begin()
- dim_end()
◆ Dim_iter
| typedef std::vector<dimension>::iterator libdap::Array::Dim_iter |
Constructor & Destructor Documentation
◆ Array() [1/3]
Array constructor.
Build an array with a name and an element type. The name may be omitted, which will create a nameless variable. The template (element type) pointer may also be omitted, but if it is omitted when the Array is created, it must be added (with add_var() od add_var_nocopy()) before read() or deserialize() is called.
This version of add_var() calls Array::add_var().
◆ Array() [2/3]
Array constructor.
Build an array on the server-side with a name, a dataset name from which this Array is being created, and an element type.
This version of add_var() calls Array::add_var().
- Parameters
-
n A string containing the name of the variable to be created. d A string containing the name of the dataset from which this variable is being created. v A pointer to a variable of the type to be included in the Array.
◆ Array() [3/3]
| libdap::Array::Array | ( | const Array & | rhs | ) |
◆ ~Array()
Member Function Documentation
◆ _duplicate()
◆ add_constraint() [1/2]
|
virtual |
◆ add_constraint() [2/2]
|
virtual |
Adds a constraint to an Array dimension.
Once a dimension has been created (see append_dim()), it can be constrained. This will make the array appear to the rest of the world to be smaller than it is. This functions sets the projection for a dimension, and marks that dimension as part of the current projection.
- Note
- A stride value <= 0 or > the array size is an error and causes add_constraint to throw an Error. Similarly, start or stop values > size also cause an Error exception to be thrown.
- Parameters
-
i An iterator pointing to the dimension in the list of dimensions. start The start index of the constraint. stride The stride value of the constraint. stop The stop index of the constraint. A value of -1 indicates 'to the end' of the array.
- Exceptions
-
Error Thrown if the any of values of start, stop or stride cannot be applied to this array.
◆ add_constraint_ll()
|
virtual |
◆ add_var()
Add the BaseType pointer to this constructor type instance.
Propagate the name of the BaseType instance to this instance. This ensures that variables at any given level of the DDS table have unique names (i.e., that Arrays do not have their default name ""). If v's name is null, then assume that the array is named and don't overwrite it with v's null name.
- Note
- It is possible for the BaseType pointer to be null when this method is called, a behavior that differs considerably from that of the other 'add_var()' methods.
- This version checks to see if v is an array. If so, it calls Vector::add_var() using the template variable of v and then appends the dimensions of v to this array. This somewhat obscure behavior simplifies 'translating' Sequences to arrays when the actual variable being translated is not a regular Sequence but an array of Sequences. This is of very debatable usefulness, but it's here all the same.
- Parameters
-
v The template variable for the array p The Part parameter defaults to nil and is ignored by this method.
◆ add_var_nocopy()
◆ append_dim() [1/2]
| void libdap::Array::append_dim | ( | D4Dimension * | dim | ) |
◆ append_dim() [2/2]
| void libdap::Array::append_dim | ( | int | size, |
| const string & | name = "" ) |
Add a dimension of a given size.
Given a size and a name, this function adds a dimension to the array. For example, if the Array is already 10 elements long, calling append_dim with a size of 5 will transform the array into a 10x5 matrix. Calling it again with a size of 2 will create a 10x5x2 array, and so on. This sets Vector's length member as a side effect.
- Parameters
-
size The size of the desired new row. name The name of the new dimension. This defaults to an empty string.
◆ append_dim_ll()
| void libdap::Array::append_dim_ll | ( | int64_t | size, |
| const string & | name = "" ) |
◆ check_semantics()
|
override |
◆ clear_all_dims()
| void libdap::Array::clear_all_dims | ( | ) |
◆ clear_constraint()
|
virtual |
Clears the projection; add each projected dimension explicitly using add_constraint.
Tell the Array object to clear the constraint information about dimensions. Do this once before calling add_constraint() for each new constraint expression. Only the dimensions explicitly selected using add_constraint() will be sent.
- Deprecated
- This should never be used.
◆ dim_begin()
| Array::Dim_iter libdap::Array::dim_begin | ( | ) |
◆ dim_end()
| Array::Dim_iter libdap::Array::dim_end | ( | ) |
◆ dimension_D4dim()
|
virtual |
◆ dimension_name()
Returns the name of the specified dimension.
This function returns the name of the dimension indicated with p. Since this method is public, it is possible to call it before the Array object has been properly initialized. This will cause an exception. So don't do that.
- Parameters
-
i The dimension.
- Returns
- A pointer to a string containing the dimension name.
◆ dimension_size()
|
virtual |
Returns the size of the dimension.
Return the size of the array dimension referred to by i. If the dimension is constrained the constrained size is returned if constrained is true.
- Parameters
-
i The dimension. constrained If this parameter is TRUE, the method returns the constrained size of the array so long as a constraint has been applied to this dimension. If TRUE and no constraint has been applied, this method returns zero. If it is FALSE, the method ignores any constraint that has been applied to this dimension and returns the full size of the dimension. The default value is FALSE.
- Returns
- An integer containing the size of the specified dimension.
◆ dimension_size_ll()
|
virtual |
◆ dimension_start()
|
virtual |
Return the start index of a dimension.
Use this function to return the start index of an array dimension. If the array is constrained (indicated with the constrained argument), the start index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_stop() and dimension_stride().
- Parameters
-
i The dimension. constrained If this parameter is TRUE, the function returns the start index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the start index whether or not the dimension is constrained.
- Returns
- The desired start index.
◆ dimension_start_ll()
|
virtual |
◆ dimension_stop()
|
virtual |
Return the stop index of the constraint.
Use this function to return the stop index of an array dimension. If the array is constrained (indicated with the constrained argument), the stop index of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_start() and dimension_stride().
- Parameters
-
i The dimension. constrained If this parameter is TRUE, the function returns the stop index only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stop index whether or not the dimension is constrained.
- Returns
- The desired stop index.
◆ dimension_stop_ll()
|
virtual |
◆ dimension_stride()
|
virtual |
Returns the stride value of the constraint.
Use this function to return the stride value of an array dimension. If the array is constrained (indicated with the constrained argument), the stride value of the constrained array is returned (or zero if the dimension in question is not selected at all). See also dimension_stop() and dimension_start().
- Parameters
-
i The dimension. constrained If this parameter is TRUE, the function returns the stride value only if the dimension is constrained (subject to a start, stop, or stride constraint). If the dimension is not constrained, the function returns zero. If it is FALSE, the function returns the stride value whether or not the dimension is constrained.
- Returns
- The stride value requested, or zero, if constrained is TRUE and the dimension is not selected.
◆ dimension_stride_ll()
|
virtual |
◆ dimensions()
|
virtual |
Return the total number of dimensions in the array.
Return the total number of dimensions contained in the array. When constrained is TRUE, return the number of dimensions given the most recently evaluated constraint expression.
- Parameters
-
constrained A boolean flag to indicate whether the array is constrained or not. Ignored.
◆ dump()
|
override |
◆ get_dio_flag()
◆ get_var_storage_info()
|
inline |
◆ is_dap2_grid()
◆ is_dap4_projected()
|
override |
◆ maps()
◆ operator=()
◆ prepend_dim() [1/2]
| void libdap::Array::prepend_dim | ( | D4Dimension * | dim | ) |
◆ prepend_dim() [2/2]
| void libdap::Array::prepend_dim | ( | int | size, |
| const string & | name = "" ) |
◆ print_array() [1/2]
|
protected |
Print the value given the current constraint.
Prints the values in ASCII of the entire (constrained) array. This method Attempts to make an aesthetically pleasing display. However, it is primarily intended for debugging purposes.
- Parameters
-
out Write the output to this FILE *. index dims shape
◆ print_array() [2/2]
|
protected |
Print the value given the current constraint.
Prints the values in ASCII of the entire (constrained) array. This method Attempts to make an anesthetically pleasing display. However, it is primarily intended for debugging purposes.
- Parameters
-
out Write the output to this ostream index dims shape
◆ print_as_map_xml() [1/2]
|
virtual |
◆ print_as_map_xml() [2/2]
|
virtual |
◆ print_as_map_xml_writer()
|
virtual |
◆ print_dap4()
|
override |
◆ print_val() [1/2]
|
override |
◆ print_val() [2/2]
◆ print_xml() [1/2]
|
override |
Prints a DDS entry for the Array.
Prints a declaration for the Array. This is what appears in a DDS. If the Array is constrained, the declaration will reflect the size of the Array once the constraint is applied.
- Parameters
-
out Write the output to this FILE *. space A string containing spaces to precede the declaration. print_semi A boolean indicating whether to print a semi-colon after the declaration. (TRUE means ``print a semi-colon.'') constraint_info A boolean value. See BaseType::print_decl(). constrained This argument should be TRUE if the Array is constrained, and FALSE otherwise. */ void Array::print_decl(FILE *out, string space, bool print_semi, bool constraint_info, bool constrained) { ostringstream oss; print_decl(oss, space, print_semi, constraint_info, constrained); fwrite(oss.str().data(), sizeof(char), oss.str().length(), out); }
/** Prints a declaration for the Array. This is what appears in a DDS. If the Array is constrained, the declaration will reflect the size of the Array once the constraint is applied.
Prints a DDS entry for the Array.
- Parameters
-
out Write the output to this ostream. space A string containing spaces to precede the declaration. print_semi A boolean indicating whether to print a semi-colon after the declaration. (TRUE means ``print a semi-colon.'') constraint_info A boolean value. See BaseType::print_decl(). constrained This argument should be TRUE if the Array is constrained, and FALSE otherwise. */ void Array::print_decl(ostream &out, string space, bool print_semi, bool constraint_info, bool constrained) { if (constrained && !send_p()) return;
print it, but w/o semicolon var()->print_decl(out, space, false, constraint_info, constrained);
for (Dim_citer i = _shape.begin(); i != _shape.end(); i++) { out << "["; if ((*i).name != "") { out << id2www((*i).name) << " = "; } if (constrained) { out << (*i).c_size << "]"; } else { out << (*i).size << "]"; } }
if (print_semi) { out << ";\n"; } }
/**
◆ print_xml() [2/2]
|
override |
◆ print_xml_core() [1/2]
|
virtual |
◆ print_xml_core() [2/2]
|
virtual |
◆ print_xml_writer()
|
override |
◆ print_xml_writer_core()
◆ ptr_duplicate()
◆ rename_dim()
◆ reset_constraint()
|
virtual |
◆ set_dio_flag()
|
inline |
◆ set_var_storage_info()
| void libdap::Array::set_var_storage_info | ( | const var_storage_info & | my_vs_info | ) |
◆ shape()
|
inlineprotected |
◆ transform_to_dap2()
|
override |
Transforms this instance of a D4Array into the corresponding DAP2 object.
This transformation may return an Array or a Grid object. The DAP2 Grid construct is semantically contained in the DAP4 concept of arrays with Map arrays. If all of the Maps are one dimensional then the D4Array can be represented as a Grid object.
- Parameters
-
The AttrTable pointer parent_attr_table is used by Groups, which disappear from the DAP2 representation. Their children are returned in the the BAseType vector their attributes are added to parent_attr_table.
◆ transform_to_dap4()
|
override |
◆ update_length()
|
virtual |
- Deprecated
- Calling this method should never be necessary. It is used internally and called whenever the size of the Array is changed, e.g., by a constraint.
Changes the length property of the array.
◆ update_length_ll()
|
virtual |
Friends And Related Symbol Documentation
◆ ArrayTest
◆ D4Group
The documentation for this class was generated from the following files:
