String column and row vector types and functions. More...

#include <dmlfw_types.h>

Include dependency graph for dmlfw_vec_string.h:

This graph shows which files directly or indirectly include this file:

typedef struct __dmlfw_column_vec_string	dmlfw_column_vec_string
	Opaque structure representing a column vector of strings.

dmlfw_column_vec_string *	dmlfw_column_vec_string_create_new (dimension_t rows)
	Creates a new column vector of strings of specified length.

void	dmlfw_column_vec_string_destroy (dmlfw_column_vec_string *vector)
	Destroys a column vector of strings and frees its memory.

dmlfw_column_vec_string *	dmlfw_column_vec_string_from_csv (const char csv_file_name, dmlfw_column_vec_string vector, dmlfw_row_vec_string **header)
	Loads a column vector of strings from a CSV file.

void	dmlfw_column_vec_string_get (dmlfw_column_vec_string vector, index_t index, char *string)
	Retrieves a string element from a column vector by index.

dimension_t	dmlfw_column_vec_string_get_size (dmlfw_column_vec_string *vector)
	Returns the size (number of elements) in a column vector.

void	dmlfw_column_vec_string_set (dmlfw_column_vec_string vector, index_t index, char string)
	Sets a string element in the column vector.

void	dmlfw_column_vec_string_to_csv (dmlfw_column_vec_string vector, const char csv_file_name, dmlfw_row_vec_string *header)
	Exports a column vector of strings to a CSV file with a header.

dmlfw_row_vec_string *	dmlfw_column_vec_string_transpose (dmlfw_column_vec_string vector, dmlfw_row_vec_string transposed_vector)
	Transposes a column vector of strings into a row vector.

typedef struct __dmlfw_row_vec_string	dmlfw_row_vec_string
	Opaque structure representing a row vector of strings.

dmlfw_row_vec_string *	dmlfw_row_vec_string_create_new (dimension_t columns)
	Creates a new row vector of strings of specified length.

void	dmlfw_row_vec_string_destroy (dmlfw_row_vec_string *vector)
	Destroys a row vector of strings and frees its memory.

dmlfw_row_vec_string *	dmlfw_row_vec_string_from_csv (const char csv_file_name, dmlfw_row_vec_string vector, dmlfw_row_vec_string **header)
	Loads a row vector of strings from a CSV file.

void	dmlfw_row_vec_string_get (dmlfw_row_vec_string vector, index_t index, char *string)
	Retrieves a string element from a row vector by index.

dimension_t	dmlfw_row_vec_string_get_size (dmlfw_row_vec_string *vector)
	Returns the size (number of elements) in a row vector.

void	dmlfw_row_vec_string_set (dmlfw_row_vec_string vector, index_t index, char string)
	Sets a string element in the row vector.

void	dmlfw_row_vec_string_to_csv (dmlfw_row_vec_string vector, const char csv_file_name, dmlfw_row_vec_string *header)
	Exports a row vector of strings to a CSV file with a header.

dmlfw_column_vec_string *	dmlfw_row_vec_string_transpose (dmlfw_row_vec_string vector, dmlfw_column_vec_string transposed_vector)
	Transposes a row vector of strings into a column vector.

Detailed Description

String column and row vector types and functions.

Version: 1.0

Date: 2025-09-25

This header defines opaque vector data structures for string values. It provides APIs for creating, destroying, accessing, modifying, and manipulating both column and row string vectors.

Common operations include:

Creation and destruction
Element access and mutation
Transposing between row and column vectors
CSV import/export
Size retrieval

Error Handling:

All functions report errors through the centralized error API:

Call dmlfw_error() to check whether an error occurred.
Use dmlfw_get_error_string() and dmlfw_get_debug_string() for error details and debugging info.

Unless otherwise stated:

Passing NULL pointers or invalid arguments sets error status.
On error, functions return NULL or 0 depending on return type.