amino
Lightweight Robot Utility Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
validate.h
Go to the documentation of this file.
1 /* -*- mode: C; c-basic-offset: 4 -*- */
2 /* ex: set shiftwidth=4 tabstop=4 expandtab: */
3 /*
4  * Copyright (c) 2011, Georgia Tech Research Corporation
5  * All rights reserved.
6  *
7  * Author(s): Neil T. Dantam <ntd@gatech.edu>
8  * Georgia Tech Humanoid Robotics Lab
9  * Under Direction of Prof. Mike Stilman <mstilman@cc.gatech.edu>
10  *
11  *
12  * This file is provided under the following "BSD-style" License:
13  *
14  *
15  * Redistribution and use in source and binary forms, with or
16  * without modification, are permitted provided that the following
17  * conditions are met:
18  *
19  * * Redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer.
21  *
22  * * Redistributions in binary form must reproduce the above
23  * copyright notice, this list of conditions and the following
24  * disclaimer in the documentation and/or other materials provided
25  * with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
28  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
29  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
32  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
35  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
36  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
38  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39  * POSSIBILITY OF SUCH DAMAGE.
40  *
41  */
42 
43 #ifndef AMINO_VALIDATE_H
44 #define AMINO_VALIDATE_H
45 
54 AA_API int aa_valid_f( double value, double min, double max );
56 
60 AA_API int aa_valid_v( double *values, size_t n, double *min, double *max,
61  size_t n_desired);
62 
63 
65 AA_API int aa_valid_vunit( double *values, size_t n, double tol );
66 
68 AA_API int aa_valid_timespec( struct timespec tm, struct timespec before,
69  struct timespec after );
70 
71 
72 #endif //AMINO_VALIDATE_H
aa_valid_vunit
AA_API int aa_valid_vunit(double *values, size_t n, double tol)
returns 0 if norm(v) == 1
aa_valid_timespec
AA_API int aa_valid_timespec(struct timespec tm, struct timespec before, struct timespec after)
returns 0 if time is within [before,after]
AA_API
#define AA_API
calling and name mangling convention for functions
Definition: amino.h:95
aa_valid_f
AA_API int aa_valid_f(double value, double min, double max)
returns 0 if value >= min and value <= max, else nonzero
aa_valid_v
AA_API int aa_valid_v(double *values, size_t n, double *min, double *max, size_t n_desired)
Validate a vector.